Plan Procedure Age Restriction Modifiers

Create PlanProcedureAgeModifier

Creates a new PlanProcedureAgeModifier

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
planProcedureAgeModifier_Key
required
integer <int32>

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

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.

modifier1
string or null <= 8 characters

The first modifier being applied to the age restriction.

modifier2
string or null <= 8 characters

The second modifier being applied to the age restriction.

modifier3
string or null <= 8 characters

The third modifier being applied to the age restriction.

modifier4
string or null <= 8 characters

The fourth modifier being applied to the age restriction.

no_Modifier
required
boolean

Identifies that the age restriction has no modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.

procedureAgeKey
required
integer <int32>

References the PlanProcedureAge.PlanProcedureAge_Key value in parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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/{procedureAgeKey}/modifiers
Request samples
{
  • "planProcedureAgeModifier_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "modifier1": "string",
  • "modifier2": "string",
  • "modifier3": "string",
  • "modifier4": "string",
  • "no_Modifier": true,
  • "procedureAgeKey": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanProcedureAgeModifier

Lists all PlanProcedureAgeModifier for the given procedureAgeKey

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}/modifiers
Request samples 
Response samples 
No sample
Get PlanProcedureAgeModifier
Gets PlanProcedureAgeModifier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
procedureAgeKey
required
integer <int32> 
ProcedureAgeKey


 
planProcedureAgeModifierKey
required
integer <int32> 
PlanProcedureAgeModifier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
procedureAgeKey
required
integer <int32> 
ProcedureAgeKey


 
planProcedureAgeModifierKey
required
integer <int32> 
PlanProcedureAgeModifier Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
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.


 
modifier1
string or null  <= 8 characters 
The first modifier being applied to the age restriction.


 
modifier2
string or null  <= 8 characters 
The second modifier being applied to the age restriction.


 
modifier3
string or null  <= 8 characters 
The third modifier being applied to the age restriction.


 
modifier4
string or null  <= 8 characters 
The fourth modifier being applied to the age restriction.


 
no_Modifier
required
boolean
Identifies that the age restriction has no modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
procedureAgeKey
required
integer <int32> 
References the PlanProcedureAge.PlanProcedureAge_Key value in parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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}/modifiers/{planProcedureAgeModifierKey}
Request samples 
{
  • "planProcedureAgeModifier_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "modifier1": "string",
  • "modifier2": "string",
  • "modifier3": "string",
  • "modifier4": "string",
  • "no_Modifier": true,
  • "procedureAgeKey": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanProcedureAgeModifier
Deletes an PlanProcedureAgeModifier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
procedureAgeKey
required
integer <int32> 
ProcedureAgeKey


 
planProcedureAgeModifierKey
required
integer <int32> 
PlanProcedureAgeModifier Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/procedure-restrictions/{procedureAgeKey}/modifiers/{planProcedureAgeModifierKey}
Request samples 
Create or Update Batch PlanProcedureAgeModifier
Create or Update multiple PlanProcedureAgeModifier 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


 
procedureAgeKey
required
integer <int32> 
ProcedureAgeKey


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
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.


 
modifier1
string or null  <= 8 characters 
The first modifier being applied to the age restriction.


 
modifier2
string or null  <= 8 characters 
The second modifier being applied to the age restriction.


 
modifier3
string or null  <= 8 characters 
The third modifier being applied to the age restriction.


 
modifier4
string or null  <= 8 characters 
The fourth modifier being applied to the age restriction.


 
no_Modifier
required
boolean
Identifies that the age restriction has no modifier. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
procedureAgeKey
required
integer <int32> 
References the PlanProcedureAge.PlanProcedureAge_Key value in parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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/{procedureAgeKey}/modifiers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}