Member Enrollment Plans

Create MemEnrollmentPlan

Creates a new MemEnrollmentPlan

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

groupID
required
string

Group ID

divisionID
required
string

Division ID

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.

member_Seq
required
string [ 1 .. 2 ] characters

References the Members.Member_Seq for this members enrollment.

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.

sub_Start_Date
required
string <date-time>

References the Subenrollment.Start_Date value in the parent table.

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 the Plan coverage.

dollar_Amount
number or null <double>

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

entry_Date
string <date-time>

Date when the record was first added.

entry_User
string or null <= 20 characters

User that first added the record.

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

plan_End
string or null <date-time>

End date of the Plan coverage.

tier
string or null <= 2 characters

The Member's 'Tier' within the selected plan on the enrollment. The Member Enrollment 'Tier' has no impact on adjudication or invoicing.

update_Date
string <date-time>

Date when the record was last updated.

update_User
string or null <= 20 characters

User that last updated the record.

use_Volume_Scale
required
boolean

Indicates if this enrollment plan record should calculate the Dollar_Amount value through the Group leve Volume settings rather than use the value stored in Dollar_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.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments
Request samples
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "sub_Start_Date": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "plan_Start": "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,
  • "plan_End": "2019-08-24T14:15:22Z",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Volume_Scale": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemEnrollmentPlan

Lists all MemEnrollmentPlan for the given subscriberID and memberSeq and groupID and divisionID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

groupID
required
string

Group ID

divisionID
required
string

Division 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}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments
Request samples 
Response samples 
No sample
Get MemEnrollmentPlan
Gets MemEnrollmentPlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
subStartDate
required
string <date-time> 
Sub 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}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}
Request samples 
Response samples 
No sample
Update MemEnrollmentPlan
Updates a specific MemEnrollmentPlan.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
subStartDate
required
string <date-time> 
Sub 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.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References the Members.Member_Seq for this members enrollment.


 
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.


 
sub_Start_Date
required
string <date-time> 
References the Subenrollment.Start_Date value in the parent table.


 
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 the Plan coverage.


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


 
entry_Date
string <date-time> 
Date when the record was first added.


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


 
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


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


 
tier
string or null  <= 2 characters 
The Member's 'Tier' within the selected plan on the enrollment. The Member Enrollment 'Tier' has no impact on adjudication or invoicing.


 
update_Date
string <date-time> 
Date when the record was last updated.


 
update_User
string or null  <= 20 characters 
User that last updated the record.


 
use_Volume_Scale
required
boolean
Indicates if this enrollment plan record should calculate the Dollar_Amount value through the Group leve Volume settings rather than use the value stored in Dollar_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.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}
Request samples 
{
  • "subscriber_ID": "string",
  • "member_Seq": "st",
  • "group_ID": "string",
  • "division_ID": "string",
  • "group_Coverage_Start": "2019-08-24T14:15:22Z",
  • "sub_Start_Date": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "plan_Start": "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,
  • "plan_End": "2019-08-24T14:15:22Z",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Volume_Scale": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemEnrollmentPlan
Deletes an MemEnrollmentPlan


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
groupCoverageStart
required
string <date-time> 
Group Coverage Start


 
subStartDate
required
string <date-time> 
Sub 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}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}
Request samples 
Create or Update Batch MemEnrollmentPlan
Create or Update multiple MemEnrollmentPlan 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


 
memberSeq
required
string
Member Seq


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
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.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References the Members.Member_Seq for this members enrollment.


 
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.


 
sub_Start_Date
required
string <date-time> 
References the Subenrollment.Start_Date value in the parent table.


 
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 the Plan coverage.


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


 
entry_Date
string <date-time> 
Date when the record was first added.


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


 
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


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


 
tier
string or null  <= 2 characters 
The Member's 'Tier' within the selected plan on the enrollment. The Member Enrollment 'Tier' has no impact on adjudication or invoicing.


 
update_Date
string <date-time> 
Date when the record was last updated.


 
update_User
string or null  <= 20 characters 
User that last updated the record.


 
use_Volume_Scale
required
boolean
Indicates if this enrollment plan record should calculate the Dollar_Amount value through the Group leve Volume settings rather than use the value stored in Dollar_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.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}