Plan Procedure Age Restrictions

Create PlanProcedureAge

Creates a new PlanProcedureAge

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
procedureAgeKey
required
integer <int32>

Unique identifier for each Procedure Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_Range_Type
string or null <= 1 characters

Unit of time used to measure the age duration. Defined by days, months, or years.

age_Type
string or null <= 16 characters

Birth Date', 'End of Birth Month', or 'Ignore Age'.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code
required
string [ 1 .. 6 ] characters

Ex Code associated with the age restriction. The selected Ex Code will apply to ages outside of the defined range.

from_Age
required
integer <int32>

Beginning of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.

from_Procedure
required
string [ 1 .. 8 ] characters

Beginning of the range of associated procedure codes.

plan_ID
required
string [ 1 .. 20 ] characters

References the Plans.Plan_ID value in parent table.

thru_Age
required
integer <int32>

Ending of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.

thru_Procedure
required
string [ 1 .. 8 ] characters

End of the range of associated procedure codes.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/procedure-restrictions
Request samples
{
  • "procedureAgeKey": 0,
  • "age_Range_Type": "s",
  • "age_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Age": 0,
  • "from_Procedure": "string",
  • "plan_ID": "string",
  • "thru_Age": 0,
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanProcedureAge

Lists all PlanProcedureAge for the given planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/procedure-restrictions
Request samples 
Response samples 
No sample
Get PlanProcedureAge
Gets PlanProcedureAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
procedureAgeKey
required
integer <int32> 
ProcedureAgeKey


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/procedure-restrictions/{procedureAgeKey}
Request samples 
Response samples 
No sample
Update PlanProcedureAge
Updates a specific PlanProcedureAge.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
procedureAgeKey
required
integer <int32> 
ProcedureAgeKey


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
procedureAgeKey
required
integer <int32> 
Unique identifier for each Procedure Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_Range_Type
string or null  <= 1 characters 
Unit of time used to measure the age duration. Defined by days, months, or years.


 
age_Type
string or null  <= 16 characters 
Birth Date', 'End of Birth Month', or 'Ignore Age'.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
ex_Code
required
string  [ 1 .. 6 ] characters 
Ex Code associated with the age restriction. The selected Ex Code will apply to ages outside of the defined range.


 
from_Age
required
integer <int32> 
Beginning of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
Beginning of the range of associated procedure codes.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID value in parent table.


 
thru_Age
required
integer <int32> 
Ending of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thru_Procedure
required
string  [ 1 .. 8 ] characters 
End of the range of associated procedure codes.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/procedure-restrictions/{procedureAgeKey}
Request samples 
{
  • "procedureAgeKey": 0,
  • "age_Range_Type": "s",
  • "age_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Age": 0,
  • "from_Procedure": "string",
  • "plan_ID": "string",
  • "thru_Age": 0,
  • "thru_Procedure": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanProcedureAge
Deletes an PlanProcedureAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
procedureAgeKey
required
integer <int32> 
ProcedureAgeKey


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/procedure-restrictions/{procedureAgeKey}
Request samples 
Create or Update Batch PlanProcedureAge
Create or Update multiple PlanProcedureAge at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
procedureAgeKey
required
integer <int32> 
Unique identifier for each Procedure Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_Range_Type
string or null  <= 1 characters 
Unit of time used to measure the age duration. Defined by days, months, or years.


 
age_Type
string or null  <= 16 characters 
Birth Date', 'End of Birth Month', or 'Ignore Age'.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
ex_Code
required
string  [ 1 .. 6 ] characters 
Ex Code associated with the age restriction. The selected Ex Code will apply to ages outside of the defined range.


 
from_Age
required
integer <int32> 
Beginning of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
Beginning of the range of associated procedure codes.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID value in parent table.


 
thru_Age
required
integer <int32> 
Ending of the range of acceptable ages. The selected Ex Code will apply to ages outside of the defined range. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thru_Procedure
required
string  [ 1 .. 8 ] characters 
End of the range of associated procedure codes.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/procedure-restrictions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}