Skip to content

Create MemEnrollmentRider

Request

Creates a new MemEnrollmentRider

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

memberSeqstringrequired

Member Seq

groupIDstringrequired

Group ID

divisionIDstringrequired

Division ID

groupCoverageStartstring, (date-time)required

Group Coverage Start

subStartDatestring, (date-time)required

Sub Start Date

planIDstringrequired

Plan ID

planStartstring, (date-time)required

Plan Start

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References the MemenrollmentPlan.Subscriber_ID value in parent table.

member_Seqstring, [ 1 .. 2 ] charactersrequired

References the MemenrollmentPlan.Member_Seq value in parent table.

group_IDstring, [ 1 .. 20 ] charactersrequired

References the MemenrollmentPlan.Group_ID value in parent table.

division_IDstring, [ 1 .. 20 ] charactersrequired

References the MemenrollmentPlan.Division_ID value in parent table.

group_Coverage_Startstring, (date-time)required

References the MemenrollmentPlan.Group_Coverage_Start value in parent table.

sub_Start_Datestring, (date-time)required

References the MemenrollmentPlan.Sub_Start_Date value in parent table.

plan_IDstring, [ 1 .. 20 ] charactersrequired

References the MemenrollmentPlan.Plan_ID value in parent table.

plan_Startstring, (date-time)required

References the MemenrollmentPlan.Plan_Start value in parent table.

benefit_Codestring, [ 1 .. 10 ] charactersrequired

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_Datestring, (date-time)required

Start date of Rider coverage.

employee_Contributionnumber or null, (double)

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

employee_Contribution_Pctbooleanrequired

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_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

external_IDstring or null, <= 64 characters

Custom value used for Ceridican tax processing interface.

ltC_Daily_Benefit_Amountnumber or null, (double)

Member elected Daily Benefit Amount

ltC_Lifetime_Max_Amountnumber or null, (double)

Lifetime Max Amount elected

ltC_Lifetime_Max_Daysinteger or null, (int32)

Lifetime Max Days elected

ltC_Lifetime_Max_Yearsinteger or null, (int32)

Lifetime Max Years elected

ltC_Monthly_Benefit_Amountnumber or null, (double)

Member elected Monthly Benefit Amount

thru_Datestring or null, (date-time)

End date of Rider coverage.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

volumenumber or null, (double)

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

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/groups/{groupID}/divisions/{divisionID}/enrollments/{groupCoverageStart}/{subStartDate}/plans/{planID}/{planStart}/riders' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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",
    "benefit_Code": "string",
    "from_Date": "2019-08-24T14:15:22Z",
    "employee_Contribution": 0.1,
    "employee_Contribution_Pct": true,
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "external_ID": "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,
    "thru_Date": "2019-08-24T14:15:22Z",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string",
    "volume": 0.1
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}