Group Contract Plan Rider External IDs

Create GroupContractPlanRiderExternalID

Creates a new GroupContractPlanRiderExternalID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References GroupContractPlanRider.Group_ID value on the parent record.

division_ID
required
string [ 1 .. 20 ] characters

References GroupContractPlanRider.Division_ID value on the parent record.

coverage_Start
required
string <date-time>

References GroupContractPlanRider.Coverage_Start value on the parent record. 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 GroupContractPlanRider.Plan_ID value on the parent record.

benefit_Code
required
string [ 1 .. 10 ] characters

References GroupContractPlanRider.Benefit_Code value on the parent record.

external_ID
required
string [ 1 .. 32 ] characters

The external ID used for custom tax reporting integrations.

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.

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.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "external_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupContractPlanRiderExternalID

Lists all GroupContractPlanRiderExternalID for the given groupID and divisionID and coverageStart and planID and benefitCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

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/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids
Request samples 
Response samples 
No sample
Get GroupContractPlanRiderExternalID
Gets GroupContractPlanRiderExternalID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
externalID
required
string
External ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids/{externalID}
Request samples 
Response samples 
No sample
Update GroupContractPlanRiderExternalID
Updates a specific GroupContractPlanRiderExternalID.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
externalID
required
string
External ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlanRider.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlanRider.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
References GroupContractPlanRider.Coverage_Start value on the parent record. 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 GroupContractPlanRider.Plan_ID value on the parent record.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References GroupContractPlanRider.Benefit_Code value on the parent record.


 
external_ID
required
string  [ 1 .. 32 ] characters 
The external ID used for custom tax reporting integrations.


 
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.


 
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.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids/{externalID}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "external_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupContractPlanRiderExternalID
Deletes an GroupContractPlanRiderExternalID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
externalID
required
string
External ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids/{externalID}
Request samples 
Create or Update Batch GroupContractPlanRiderExternalID
Create or Update multiple GroupContractPlanRiderExternalID 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
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlanRider.Group_ID value on the parent record.


 
division_ID
required
string  [ 1 .. 20 ] characters 
References GroupContractPlanRider.Division_ID value on the parent record.


 
coverage_Start
required
string <date-time> 
References GroupContractPlanRider.Coverage_Start value on the parent record. 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 GroupContractPlanRider.Plan_ID value on the parent record.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References GroupContractPlanRider.Benefit_Code value on the parent record.


 
external_ID
required
string  [ 1 .. 32 ] characters 
The external ID used for custom tax reporting integrations.


 
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.


 
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.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/riders/{benefitCode}/external-ids-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}