Plan Relationship Age Restrictions

Create PlanRelationshipAge

Creates a new PlanRelationshipAge

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planRelationshipAge_Key
required
integer <int32>

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

age_Type
string or null <= 16 characters

Birth Date' or 'End of Birth Month'

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.

plan_ID
required
string [ 1 .. 20 ] characters

References the Plans.Plan_ID value in parent table.

relate_Code
required
string [ 1 .. 8 ] characters

Code that identifies the relationship associated with the age restriction.

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.

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/plan-relationship-age-restrictions
Request samples
{
  • "planRelationshipAge_Key": 0,
  • "age_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Age": 0,
  • "plan_ID": "string",
  • "relate_Code": "string",
  • "thru_Age": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanRelationshipAge

Lists all PlanRelationshipAge for the given planID

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plan-relationship-age-restrictions
Request samples 
Response samples 
No sample
Get PlanRelationshipAge
Gets PlanRelationshipAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planRelationshipAgeKey
required
integer <int32> 
PlanRelationshipAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plan-relationship-age-restrictions/{planRelationshipAgeKey}
Request samples 
Response samples 
No sample
Update PlanRelationshipAge
Updates a specific PlanRelationshipAge.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planRelationshipAgeKey
required
integer <int32> 
PlanRelationshipAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
age_Type
string or null  <= 16 characters 
Birth Date' or 'End of Birth Month'


 
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.


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


 
relate_Code
required
string  [ 1 .. 8 ] characters 
Code that identifies the relationship associated with the age restriction.


 
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.


 
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/plan-relationship-age-restrictions/{planRelationshipAgeKey}
Request samples 
{
  • "planRelationshipAge_Key": 0,
  • "age_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Age": 0,
  • "plan_ID": "string",
  • "relate_Code": "string",
  • "thru_Age": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanRelationshipAge
Deletes an PlanRelationshipAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planRelationshipAgeKey
required
integer <int32> 
PlanRelationshipAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plan-relationship-age-restrictions/{planRelationshipAgeKey}
Request samples 
Create or Update Batch PlanRelationshipAge
Create or Update multiple PlanRelationshipAge at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


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


 
age_Type
string or null  <= 16 characters 
Birth Date' or 'End of Birth Month'


 
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.


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


 
relate_Code
required
string  [ 1 .. 8 ] characters 
Code that identifies the relationship associated with the age restriction.


 
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.


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