Subscriber Enrollment Plan Riders

Create SubEnrollmentRider

Creates a new SubEnrollmentRider

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

divisionID
required
string

Division ID

groupCoverageStart
required
string <date-time>

Group Coverage Start

startDate
required
string <date-time>

Start Date

planID
required
string

Plan ID

planStart
required
string <date-time>

Plan Start

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References the SubenrollmentPlan.Subscriber_ID value in the parent table.

group_ID
required
string [ 1 .. 20 ] characters

References the SubenrollmentPlan.Group_ID value in the parent table.

division_ID
required
string [ 1 .. 20 ] characters

References the SubenrollmentPlan.Division_ID value in the parent table.

group_Coverage_Start
required
string <date-time>

References the SubenrollmentPlan.Group_Coverage_Start value in the parent table.

start_Date
required
string <date-time>

References the SubenrollmentPlan.Start_Date value in the parent table.

plan_ID
required
string [ 1 .. 20 ] characters

References the SubenrollmentPlan.Plan_ID value in the parent table.

plan_Start
required
string <date-time>

References the SubenrollmentPlan.Plan_Start value in the parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in.

from_Date
required
string <date-time>

Start date of Rider coverage.

billing_Member_Seq_Override
string or null <= 2 characters

By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations.

employee_Contribution
number or null <double>

Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts.

employee_Contribution_Pct
required
boolean

Indicates if the Emploee Contribution amount entered is a Pct or flat amount. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

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.

external_ID
string or null <= 64 characters

Custom value used for Ceridican tax processing interface.

initial_Volume
number or null <double>

This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.

initial_Volume_Salary_Pct
required
boolean

Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

ltC_Daily_Benefit_Amount
number or null <double>

Member elected Daily Benefit Amount

ltC_Lifetime_Max_Amount
number or null <double>

Lifetime Max Amount elected

ltC_Lifetime_Max_Days
integer or null <int32>

Lifetime Max Days elected

ltC_Lifetime_Max_Years
integer or null <int32>

Lifetime Max Years elected

ltC_Monthly_Benefit_Amount
number or null <double>

Member elected Monthly Benefit Amount

new_CommissionAgencyRep_Key
integer or null <int32>

No longer in use.

original_CommissionAgencyRep_Key
integer or null <int32>

No longer in use.

thru_Date
string or null <date-time>

End date of Rider coverage.

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_Employee_Age
required
boolean

Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

use_GI_Volume_Min_Max
required
boolean

The 'Gaurantee Issue' option is an alternative to the 'Use Scale' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

use_Volume_Scale
required
boolean

This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.

volume
number or null <double>

The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders
Request samples
{
  • "subscriber_ID": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "plan_Start": "2019-08-24T14:15:22Z",
  • "benefit_Code": "string",
  • "from_Date": "2019-08-24T14:15:22Z",
  • "billing_Member_Seq_Override": "st",
  • "employee_Contribution": 0.1,
  • "employee_Contribution_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "external_ID": "string",
  • "initial_Volume": 0.1,
  • "initial_Volume_Salary_Pct": true,
  • "ltC_Daily_Benefit_Amount": 0.1,
  • "ltC_Lifetime_Max_Amount": 0.1,
  • "ltC_Lifetime_Max_Days": 0,
  • "ltC_Lifetime_Max_Years": 0,
  • "ltC_Monthly_Benefit_Amount": 0.1,
  • "new_CommissionAgencyRep_Key": 0,
  • "original_CommissionAgencyRep_Key": 0,
  • "thru_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Employee_Age": true,
  • "use_GI_Volume_Min_Max": true,
  • "use_Volume_Scale": true,
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubEnrollmentRider

Lists all SubEnrollmentRider for the given subscriberID and groupID and divisionID and groupCoverageStart and startDate and planID and planStart

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

groupID
required
string

Group ID

divisionID
required
string

Division ID

groupCoverageStart
required
string <date-time>

Group Coverage Start

startDate
required
string <date-time>

Start Date

planID
required
string

Plan ID

planStart
required
string <date-time>

Plan Start

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/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders
Request samples 
Response samples 
No sample
Get SubEnrollmentRider
Gets SubEnrollmentRider


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
planID
required
string
Plan ID


 
planStart
required
string <date-time> 
Plan Start


 
benefitCode
required
string
Benefit Code


 
fromDate
required
string <date-time> 
From Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}
Request samples 
Response samples 
No sample
Update SubEnrollmentRider
Updates a specific SubEnrollmentRider.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
planID
required
string
Plan ID


 
planStart
required
string <date-time> 
Plan Start


 
benefitCode
required
string
Benefit Code


 
fromDate
required
string <date-time> 
From Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References the SubenrollmentPlan.Subscriber_ID value in the parent table.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References the SubenrollmentPlan.Group_ID value in the parent table.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References the SubenrollmentPlan.Division_ID value in the parent table.


 
group_Coverage_Start
required
string <date-time> 
References the SubenrollmentPlan.Group_Coverage_Start value in the parent table.


 
start_Date
required
string <date-time> 
References the SubenrollmentPlan.Start_Date value in the parent table.


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


 
plan_Start
required
string <date-time> 
References the SubenrollmentPlan.Plan_Start value in the parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in.


 
from_Date
required
string <date-time> 
Start date of Rider coverage.


 
billing_Member_Seq_Override
string or null  <= 2 characters 
By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations.


 
employee_Contribution
number or null <double> 
Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts.


 
employee_Contribution_Pct
required
boolean
Indicates if the Emploee Contribution amount entered is a Pct or flat amount.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
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.


 
external_ID
string or null  <= 64 characters 
Custom value used for Ceridican tax processing interface.


 
initial_Volume
number or null <double> 
This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.


 
initial_Volume_Salary_Pct
required
boolean
Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
ltC_Daily_Benefit_Amount
number or null <double> 
Member elected Daily Benefit Amount


 
ltC_Lifetime_Max_Amount
number or null <double> 
Lifetime Max Amount elected


 
ltC_Lifetime_Max_Days
integer or null <int32> 
Lifetime Max Days elected


 
ltC_Lifetime_Max_Years
integer or null <int32> 
Lifetime Max Years elected


 
ltC_Monthly_Benefit_Amount
number or null <double> 
Member elected Monthly Benefit Amount


 
new_CommissionAgencyRep_Key
integer or null <int32> 
No longer in use.


 
original_CommissionAgencyRep_Key
integer or null <int32> 
No longer in use.


 
thru_Date
string or null <date-time> 
End date of Rider coverage.


 
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_Employee_Age
required
boolean
Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
use_GI_Volume_Min_Max
required
boolean
The 'Gaurantee Issue' option is an alternative to the 'Use Scale' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
use_Volume_Scale
required
boolean
This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
volume
number or null <double> 
The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}
Request samples 
{
  • "subscriber_ID": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "plan_Start": "2019-08-24T14:15:22Z",
  • "benefit_Code": "string",
  • "from_Date": "2019-08-24T14:15:22Z",
  • "billing_Member_Seq_Override": "st",
  • "employee_Contribution": 0.1,
  • "employee_Contribution_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "external_ID": "string",
  • "initial_Volume": 0.1,
  • "initial_Volume_Salary_Pct": true,
  • "ltC_Daily_Benefit_Amount": 0.1,
  • "ltC_Lifetime_Max_Amount": 0.1,
  • "ltC_Lifetime_Max_Days": 0,
  • "ltC_Lifetime_Max_Years": 0,
  • "ltC_Monthly_Benefit_Amount": 0.1,
  • "new_CommissionAgencyRep_Key": 0,
  • "original_CommissionAgencyRep_Key": 0,
  • "thru_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Employee_Age": true,
  • "use_GI_Volume_Min_Max": true,
  • "use_Volume_Scale": true,
  • "volume": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubEnrollmentRider
Deletes an SubEnrollmentRider


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
planID
required
string
Plan ID


 
planStart
required
string <date-time> 
Plan Start


 
benefitCode
required
string
Benefit Code


 
fromDate
required
string <date-time> 
From Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders/{benefitCode}/{fromDate}
Request samples 
Create or Update Batch SubEnrollmentRider
Create or Update multiple SubEnrollmentRider 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
subscriberID
required
string
Subscriber ID


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
startDate
required
string <date-time> 
Start Date


 
planID
required
string
Plan ID


 
planStart
required
string <date-time> 
Plan Start


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References the SubenrollmentPlan.Subscriber_ID value in the parent table.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References the SubenrollmentPlan.Group_ID value in the parent table.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References the SubenrollmentPlan.Division_ID value in the parent table.


 
group_Coverage_Start
required
string <date-time> 
References the SubenrollmentPlan.Group_Coverage_Start value in the parent table.


 
start_Date
required
string <date-time> 
References the SubenrollmentPlan.Start_Date value in the parent table.


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


 
plan_Start
required
string <date-time> 
References the SubenrollmentPlan.Plan_Start value in the parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the BenefitCodes.Benefit_Code value that is flagged as a Rider on this Plan and indicates the optional coverage this member has enrolled in.


 
from_Date
required
string <date-time> 
Start date of Rider coverage.


 
billing_Member_Seq_Override
string or null  <= 2 characters 
By default, billing calculations use the insured demographic information for determing the settings. This value allows another member of the family to be used when determining those calculations.


 
employee_Contribution
number or null <double> 
Indicates the Employee Contribution amount that is used during Diability processing to properly take tax amounts.


 
employee_Contribution_Pct
required
boolean
Indicates if the Emploee Contribution amount entered is a Pct or flat amount.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
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.


 
external_ID
string or null  <= 64 characters 
Custom value used for Ceridican tax processing interface.


 
initial_Volume
number or null <double> 
This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.


 
initial_Volume_Salary_Pct
required
boolean
Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
ltC_Daily_Benefit_Amount
number or null <double> 
Member elected Daily Benefit Amount


 
ltC_Lifetime_Max_Amount
number or null <double> 
Lifetime Max Amount elected


 
ltC_Lifetime_Max_Days
integer or null <int32> 
Lifetime Max Days elected


 
ltC_Lifetime_Max_Years
integer or null <int32> 
Lifetime Max Years elected


 
ltC_Monthly_Benefit_Amount
number or null <double> 
Member elected Monthly Benefit Amount


 
new_CommissionAgencyRep_Key
integer or null <int32> 
No longer in use.


 
original_CommissionAgencyRep_Key
integer or null <int32> 
No longer in use.


 
thru_Date
string or null <date-time> 
End date of Rider coverage.


 
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_Employee_Age
required
boolean
Billing setting indicating that the employee age is used in all calculations that are age based for this specific Rider.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
use_GI_Volume_Min_Max
required
boolean
The 'Gaurantee Issue' option is an alternative to the 'Use Scale' option. It offers a convenient secondary option for min/max when calculating Rider volume. Plan type must include the "Life AD&D" indicator.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
use_Volume_Scale
required
boolean
This option tells the system to calculate the 'Volume' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Plan type must include the "Life AD&D" indicator.  Note: The database will apply a default value of False for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected.


 
volume
number or null <double> 
The Member's 'Volume' within the selected Rider benefit on the enrollment. The Member Enrollment 'Volume' has no impact on invoicing.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}/riders-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}