Plan Disability Limits

Create DisabilityPlanLimit

Creates a new DisabilityPlanLimit

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
disabilityPlanLimit_Key
required
integer <int32>

Unique Identifier for the DisabilityPlanLimit table.

age_From
integer or null <int32>

Starting Age the plan limit applies to.

age_Thru
integer or null <int32>

Ending Age the plan limit applies to.

age_Type
string or null <= 8 characters

Age Type the plan limit applies to.

disability_Type
string or null <= 8 characters

Identifies the type of disability (injury or illness).

limit
integer or null <int32>

Plan limit to apply.

limit_Type
string or null <= 1 characters

Type of plan limit.

limit_Type_From
string or null <= 8 characters

Starting value the plan limit applies to.

plan_ID
string or null <= 20 characters

Plan ID of the plan to limit.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/disability-limits
Request samples
{
  • "disabilityPlanLimit_Key": 0,
  • "age_From": 0,
  • "age_Thru": 0,
  • "age_Type": "string",
  • "disability_Type": "string",
  • "limit": 0,
  • "limit_Type": "s",
  • "limit_Type_From": "string",
  • "plan_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List DisabilityPlanLimit

Lists all DisabilityPlanLimit 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}/disability-limits
Request samples 
Response samples 
No sample
Get DisabilityPlanLimit
Gets DisabilityPlanLimit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
disabilityPlanLimitKey
required
integer <int32> 
DisabilityPlanLimit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/disability-limits/{disabilityPlanLimitKey}
Request samples 
Response samples 
No sample
Update DisabilityPlanLimit
Updates a specific DisabilityPlanLimit.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
disabilityPlanLimitKey
required
integer <int32> 
DisabilityPlanLimit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
disabilityPlanLimit_Key
required
integer <int32> 
Unique Identifier for the DisabilityPlanLimit table.


 
age_From
integer or null <int32> 
Starting Age the plan limit applies to.


 
age_Thru
integer or null <int32> 
Ending Age the plan limit applies to.


 
age_Type
string or null  <= 8 characters 
Age Type the plan limit applies to.


 
disability_Type
string or null  <= 8 characters 
Identifies the type of disability (injury or illness).


 
limit
integer or null <int32> 
Plan limit to apply.


 
limit_Type
string or null  <= 1 characters 
Type of plan limit.


 
limit_Type_From
string or null  <= 8 characters 
Starting value the plan limit applies to.


 
plan_ID
string or null  <= 20 characters 
Plan ID of the plan to limit.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/disability-limits/{disabilityPlanLimitKey}
Request samples 
{
  • "disabilityPlanLimit_Key": 0,
  • "age_From": 0,
  • "age_Thru": 0,
  • "age_Type": "string",
  • "disability_Type": "string",
  • "limit": 0,
  • "limit_Type": "s",
  • "limit_Type_From": "string",
  • "plan_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete DisabilityPlanLimit
Deletes an DisabilityPlanLimit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
disabilityPlanLimitKey
required
integer <int32> 
DisabilityPlanLimit Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/disability-limits/{disabilityPlanLimitKey}
Request samples 
Create or Update Batch DisabilityPlanLimit
Create or Update multiple DisabilityPlanLimit 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 
disabilityPlanLimit_Key
required
integer <int32> 
Unique Identifier for the DisabilityPlanLimit table.


 
age_From
integer or null <int32> 
Starting Age the plan limit applies to.


 
age_Thru
integer or null <int32> 
Ending Age the plan limit applies to.


 
age_Type
string or null  <= 8 characters 
Age Type the plan limit applies to.


 
disability_Type
string or null  <= 8 characters 
Identifies the type of disability (injury or illness).


 
limit
integer or null <int32> 
Plan limit to apply.


 
limit_Type
string or null  <= 1 characters 
Type of plan limit.


 
limit_Type_From
string or null  <= 8 characters 
Starting value the plan limit applies to.


 
plan_ID
string or null  <= 20 characters 
Plan ID of the plan to limit.


 
Responses 
207
Success


401
Unauthorized


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