Group Contract Plan Riders

Create GroupContractPlanRider

Creates a new GroupContractPlanRider

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References GroupContractPlan.Group_ID value on the parent record.

division_ID
required
string [ 1 .. 20 ] characters

References GroupContractPlan.Division_ID value on the parent record.

coverage_Start
required
string <date-time>

References GroupContractPlan.Coverage_Start value on the parent record. 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 GroupContractPlan.Plan_ID value on the parent record.

benefit_Code
required
string [ 1 .. 10 ] characters

This is the rider being offered for this plan on this contract. The rider is pulled from the list of PlanBenefits with a Rider value = 1.

combined_Volume_Max
number or null <double>

For disability claims this will work with the individual volume max for each payment and set a total max for all payments. The rest are not covered.

employee_Contribution
number or null <double>

For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)

employee_Contribution_Pct
required
boolean

For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. 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 first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

funding_Indicator
string or null <= 1 characters

Information only, used in custom client reporting.

minimum_Benefit
number or null <double>

This is the minimum benefit assigned to each disability payment in all benefit calculations (working with volume minimum).

premium
number or null <double>

No longer in use.

salary_Pct
number or null <double>

If "Use_Salary_Pct" is selected, this is the percentage.

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.

use_Salary_Pct
required
boolean

Indicates if a percent of salary should be used when determing this benefit amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

volume
number or null <double>

For disability enrollment, this shows the weekly (for STD) or monthly (for LTD) benefit amount.

volume_Max
number or null <double>

When using a salary based benefit, this indicates the max volume (benefit amount) for that calculation.

volume_Min
number or null <double>

When using a salary based benefit, this indicates the minimum volume (benefit amount) for that calculation.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "combined_Volume_Max": 0.1,
  • "employee_Contribution": 0.1,
  • "employee_Contribution_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Indicator": "s",
  • "minimum_Benefit": 0.1,
  • "premium": 0.1,
  • "salary_Pct": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Salary_Pct": true,
  • "volume": 0.1,
  • "volume_Max": 0.1,
  • "volume_Min": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupContractPlanRider

Lists all GroupContractPlanRider for the given groupID and divisionID and coverageStart and planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

planID
required
string

Plan ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders
Request samples 
Response samples 
No sample
Get GroupContractPlanRider
Gets GroupContractPlanRider


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}
Request samples 
Response samples 
No sample
Update GroupContractPlanRider
Updates a specific GroupContractPlanRider.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlan.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlan.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
References GroupContractPlan.Coverage_Start value on the parent record. 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 GroupContractPlan.Plan_ID value on the parent record.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
This is the rider being offered for this plan on this contract. The rider is pulled from the list of PlanBenefits with a Rider value = 1.


 
combined_Volume_Max
number or null <double> 
For disability claims this will work with the individual volume max for each payment and set a total max for all payments. The rest are not covered.


 
employee_Contribution
number or null <double> 
For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)


 
employee_Contribution_Pct
required
boolean
For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. 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 first added to the system.


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


 
funding_Indicator
string or null  <= 1 characters 
Information only, used in custom client reporting.


 
minimum_Benefit
number or null <double> 
This is the minimum benefit assigned to each disability payment in all benefit calculations (working with volume minimum).


 
premium
number or null <double> 
No longer in use.


 
salary_Pct
number or null <double> 
If "Use_Salary_Pct" is selected, this is the percentage.


 
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.


 
use_Salary_Pct
required
boolean
Indicates if a percent of salary should be used when determing this benefit amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
For disability enrollment, this shows the weekly (for STD) or monthly (for LTD) benefit amount.


 
volume_Max
number or null <double> 
When using a salary based benefit, this indicates the max volume (benefit amount) for that calculation.


 
volume_Min
number or null <double> 
When using a salary based benefit, this indicates the minimum volume (benefit amount) for that calculation.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "combined_Volume_Max": 0.1,
  • "employee_Contribution": 0.1,
  • "employee_Contribution_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Indicator": "s",
  • "minimum_Benefit": 0.1,
  • "premium": 0.1,
  • "salary_Pct": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Salary_Pct": true,
  • "volume": 0.1,
  • "volume_Max": 0.1,
  • "volume_Min": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupContractPlanRider
Deletes an GroupContractPlanRider


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}
Request samples 
Create or Update Batch GroupContractPlanRider
Create or Update multiple GroupContractPlanRider 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
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlan.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlan.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
References GroupContractPlan.Coverage_Start value on the parent record. 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 GroupContractPlan.Plan_ID value on the parent record.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
This is the rider being offered for this plan on this contract. The rider is pulled from the list of PlanBenefits with a Rider value = 1.


 
combined_Volume_Max
number or null <double> 
For disability claims this will work with the individual volume max for each payment and set a total max for all payments. The rest are not covered.


 
employee_Contribution
number or null <double> 
For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)


 
employee_Contribution_Pct
required
boolean
For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. 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 first added to the system.


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


 
funding_Indicator
string or null  <= 1 characters 
Information only, used in custom client reporting.


 
minimum_Benefit
number or null <double> 
This is the minimum benefit assigned to each disability payment in all benefit calculations (working with volume minimum).


 
premium
number or null <double> 
No longer in use.


 
salary_Pct
number or null <double> 
If "Use_Salary_Pct" is selected, this is the percentage.


 
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.


 
use_Salary_Pct
required
boolean
Indicates if a percent of salary should be used when determing this benefit amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
For disability enrollment, this shows the weekly (for STD) or monthly (for LTD) benefit amount.


 
volume_Max
number or null <double> 
When using a salary based benefit, this indicates the max volume (benefit amount) for that calculation.


 
volume_Min
number or null <double> 
When using a salary based benefit, this indicates the minimum volume (benefit amount) for that calculation.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}