Subscriber Enrollment Plans

Create SubEnrollmentPlan

Creates a new SubEnrollmentPlan

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

header Parameters
vbasoftware-database
required
string

Target database

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

References the Subenrollment.Subscriber_ID value in the parent table.

group_ID
required
string [ 1 .. 20 ] characters

References the Subenrollment.Group_ID value in the parent table.

division_ID
required
string [ 1 .. 20 ] characters

References the Subenrollment.Division_ID value in the parent table.

group_Coverage_Start
required
string <date-time>

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

start_Date
required
string <date-time>

References the Subenrollment.Start_Date value in the parent table. 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 GroupContractPlan.Plan_ID value indicating which Plan this member is enrolling that is being offered.

plan_Start
required
string <date-time>

Start date of Plan coverage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

application_Received_Date
string or null <date-time>

Holds the date for the subscriber's application to disclose pre-existing conditions.

dollar_Amount
number or null <double>

The Subscriber's 'Volume' within the selected plan on the enrollment. This will impact invoicing.

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

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

paid_Through
string or null <date-time>

Date that the premiums have been paid through for this plan. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.

plan_End
string or null <date-time>

End date of Plan coverage.

reason_ID
integer or null <int32>

This identifier the reason the plan was termed.

tier
string or null <= 2 characters

The Subscriber's 'Tier' within the selected plan on the enrollment. This will impact adjudication and invoicing.

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_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. Note: This field is marked as NOT NULL in the database and therefore required by the API.

writing_CommissionAgencyRep_Key
integer or null <int32>

Unique identifier for the CommissionAgencyRep table

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans
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",
  • "application_Received_Date": "2019-08-24T14:15:22Z",
  • "dollar_Amount": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "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,
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "plan_End": "2019-08-24T14:15:22Z",
  • "reason_ID": 0,
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Volume_Scale": true,
  • "writing_CommissionAgencyRep_Key": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubEnrollmentPlan

Lists all SubEnrollmentPlan for the given Subscriber, Group, Division and Enrollment

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

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
Request samples 
Response samples 
No sample
List Subscriber SubEnrollmentPlans
Lists all SubEnrollmentPlans for the given Subscriber


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber 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/subscribers/{subscriberID}/plans
Request samples 
Response samples 
No sample
Get SubEnrollmentPlan
Gets SubEnrollmentPlan


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


 
Responses 
200
Success


401
Unauthorized


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


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 Subenrollment.Subscriber_ID value in the parent table.


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


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


 
group_Coverage_Start
required
string <date-time> 
References the Subenrollment.Group_Coverage_Start value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
start_Date
required
string <date-time> 
References the Subenrollment.Start_Date value in the parent table. 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 GroupContractPlan.Plan_ID value indicating which Plan this member is enrolling that is being offered.


 
plan_Start
required
string <date-time> 
Start date of Plan coverage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
application_Received_Date
string or null <date-time> 
Holds the date for the subscriber's application to disclose pre-existing conditions.


 
dollar_Amount
number or null <double> 
The Subscriber's 'Volume' within the selected plan on the enrollment. This will impact invoicing.


 
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


 
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


 
paid_Through
string or null <date-time> 
Date that the premiums have been paid through for this plan. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.


 
plan_End
string or null <date-time> 
End date of Plan coverage.


 
reason_ID
integer or null <int32> 
This identifier the reason the plan was termed.


 
tier
string or null  <= 2 characters 
The Subscriber's 'Tier' within the selected plan on the enrollment. This will impact adjudication and invoicing.


 
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_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. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
writing_CommissionAgencyRep_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRep table


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}
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",
  • "application_Received_Date": "2019-08-24T14:15:22Z",
  • "dollar_Amount": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "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,
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "plan_End": "2019-08-24T14:15:22Z",
  • "reason_ID": 0,
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Volume_Scale": true,
  • "writing_CommissionAgencyRep_Key": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubEnrollmentPlan
Deletes an SubEnrollmentPlan


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


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans/{planID}/{planStart}
Request samples 
Create or Update Batch SubEnrollmentPlan
Create or Update multiple SubEnrollmentPlan 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


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


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


 
group_Coverage_Start
required
string <date-time> 
References the Subenrollment.Group_Coverage_Start value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
start_Date
required
string <date-time> 
References the Subenrollment.Start_Date value in the parent table. 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 GroupContractPlan.Plan_ID value indicating which Plan this member is enrolling that is being offered.


 
plan_Start
required
string <date-time> 
Start date of Plan coverage. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
application_Received_Date
string or null <date-time> 
Holds the date for the subscriber's application to disclose pre-existing conditions.


 
dollar_Amount
number or null <double> 
The Subscriber's 'Volume' within the selected plan on the enrollment. This will impact invoicing.


 
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


 
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


 
paid_Through
string or null <date-time> 
Date that the premiums have been paid through for this plan. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.


 
plan_End
string or null <date-time> 
End date of Plan coverage.


 
reason_ID
integer or null <int32> 
This identifier the reason the plan was termed.


 
tier
string or null  <= 2 characters 
The Subscriber's 'Tier' within the selected plan on the enrollment. This will impact adjudication and invoicing.


 
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_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. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
writing_CommissionAgencyRep_Key
integer or null <int32> 
Unique identifier for the CommissionAgencyRep table


 
Responses 
207
Success


401
Unauthorized


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