Skip to content
/
Create or Update Batch Su...

Create or Update Batch SubEnrollmentPlan

Request

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.

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

groupIDstringrequired

Group ID

divisionIDstringrequired

Division ID

groupCoverageStartstring, (date-time)required

Group Coverage Start

startDatestring, (date-time)required

Start Date

Headers
vbasoftware-databasestringrequired

Target database

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

References the Subenrollment.Subscriber_ID value in the parent table.

group_IDstring, [ 1 .. 20 ] charactersrequired

References the Subenrollment.Group_ID value in the parent table.

division_IDstring, [ 1 .. 20 ] charactersrequired

References the Subenrollment.Division_ID value in the parent table.

group_Coverage_Startstring, (date-time)required

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

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_IDstring, [ 1 .. 20 ] charactersrequired

References the GroupContractPlan.Plan_ID value indicating which Plan this member is enrolling that is being offered.

plan_Startstring, (date-time)required

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

application_Received_Datestring or null, (date-time)

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

dollar_Amountnumber or null, (double)

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

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

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

paid_Throughstring 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_Endstring or null, (date-time)

End date of Plan coverage.

reason_IDinteger or null, (int32)

This identifier the reason the plan was termed.

tierstring or null, <= 2 characters

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

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

use_Volume_Scalebooleanrequired

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_Keyinteger or null, (int32)

Unique identifier for the CommissionAgencyRep table

]
curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans-batch' \
  -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",
      "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
    }
  ]'

Responses

Success

Bodyapplication/json
dataArray of objects or null
errorobject
debugobject
Response
{
  "data": [ … ],
  "error": { … },
  "debug": { … }
}