Group Contract Plan Premiums

Create GroupContractPlanPremium

Creates a new GroupContractPlanPremium

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

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupContractPlanPremium_Key
required
integer <int32>

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adult
required
boolean

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_From
integer or null <int32>

No longer in use. Replaced by Premium Billing module.

age_Thru
integer or null <int32>

No longer in use. Replaced by Premium Billing module.

applies_To
string or null <= 8 characters

No longer in use. Replaced by Premium Billing module.

billing_Basis
required
string = 1 characters

No longer in use. Replaced by Premium Billing module.

child
required
boolean

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coverage_Start
required
string <date-time>

No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_ID
required
string [ 1 .. 20 ] characters

No longer in use. Replaced by Premium Billing module.

entry_Date
string <date-time>

No longer in use. Replaced by Premium Billing module.

entry_User
string or null <= 20 characters

No longer in use. Replaced by Premium Billing module.

group_ID
required
string [ 1 .. 20 ] characters

No longer in use. Replaced by Premium Billing module.

maximum
number or null <double>

No longer in use. Replaced by Premium Billing module.

plan_ID
required
string [ 1 .. 20 ] characters

No longer in use. Replaced by Premium Billing module.

premium
number or null <double>

No longer in use. Replaced by Premium Billing module.

sex
string or null <= 1 characters

No longer in use. Replaced by Premium Billing module.

tier
string or null <= 2 characters

No longer in use. Replaced by Premium Billing module.

update_Date
string <date-time>

No longer in use. Replaced by Premium Billing module.

update_User
string or null <= 20 characters

No longer in use. Replaced by Premium Billing module.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums
Request samples
{
  • "groupContractPlanPremium_Key": 0,
  • "adult": true,
  • "age_From": 0,
  • "age_Thru": 0,
  • "applies_To": "string",
  • "billing_Basis": "s",
  • "child": true,
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "maximum": 0.1,
  • "plan_ID": "string",
  • "premium": 0.1,
  • "sex": "s",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupContractPlanPremium

Lists all GroupContractPlanPremium for the given groupID and divisionID and coverageStart and planID

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

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}/premiums
Request samples 
Response samples 
No sample
Get GroupContractPlanPremium
Gets GroupContractPlanPremium


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


 
groupContractPlanPremiumKey
required
integer <int32> 
GroupContractPlanPremium Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums/{groupContractPlanPremiumKey}
Request samples 
Response samples 
No sample
Update GroupContractPlanPremium
Updates a specific GroupContractPlanPremium.


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


 
groupContractPlanPremiumKey
required
integer <int32> 
GroupContractPlanPremium Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupContractPlanPremium_Key
required
integer <int32> 
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adult
required
boolean
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
No longer in use. Replaced by Premium Billing module.


 
age_Thru
integer or null <int32> 
No longer in use. Replaced by Premium Billing module.


 
applies_To
string or null  <= 8 characters 
No longer in use. Replaced by Premium Billing module.


 
billing_Basis
required
string  = 1 characters 
No longer in use. Replaced by Premium Billing module.


 
child
required
boolean
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coverage_Start
required
string <date-time> 
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by Premium Billing module.


 
entry_Date
string <date-time> 
No longer in use. Replaced by Premium Billing module.


 
entry_User
string or null  <= 20 characters 
No longer in use. Replaced by Premium Billing module.


 
group_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by Premium Billing module.


 
maximum
number or null <double> 
No longer in use. Replaced by Premium Billing module.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by Premium Billing module.


 
premium
number or null <double> 
No longer in use. Replaced by Premium Billing module.


 
sex
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
tier
string or null  <= 2 characters 
No longer in use. Replaced by Premium Billing module.


 
update_Date
string <date-time> 
No longer in use. Replaced by Premium Billing module.


 
update_User
string or null  <= 20 characters 
No longer in use. Replaced by Premium Billing module.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums/{groupContractPlanPremiumKey}
Request samples 
{
  • "groupContractPlanPremium_Key": 0,
  • "adult": true,
  • "age_From": 0,
  • "age_Thru": 0,
  • "applies_To": "string",
  • "billing_Basis": "s",
  • "child": true,
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "maximum": 0.1,
  • "plan_ID": "string",
  • "premium": 0.1,
  • "sex": "s",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupContractPlanPremium
Deletes an GroupContractPlanPremium


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


 
groupContractPlanPremiumKey
required
integer <int32> 
GroupContractPlanPremium Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans/{planID}/premiums/{groupContractPlanPremiumKey}
Request samples 
Create or Update Batch GroupContractPlanPremium
Create or Update multiple GroupContractPlanPremium 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupContractPlanPremium_Key
required
integer <int32> 
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adult
required
boolean
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
No longer in use. Replaced by Premium Billing module.


 
age_Thru
integer or null <int32> 
No longer in use. Replaced by Premium Billing module.


 
applies_To
string or null  <= 8 characters 
No longer in use. Replaced by Premium Billing module.


 
billing_Basis
required
string  = 1 characters 
No longer in use. Replaced by Premium Billing module.


 
child
required
boolean
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
coverage_Start
required
string <date-time> 
No longer in use. Replaced by Premium Billing module. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by Premium Billing module.


 
entry_Date
string <date-time> 
No longer in use. Replaced by Premium Billing module.


 
entry_User
string or null  <= 20 characters 
No longer in use. Replaced by Premium Billing module.


 
group_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by Premium Billing module.


 
maximum
number or null <double> 
No longer in use. Replaced by Premium Billing module.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
No longer in use. Replaced by Premium Billing module.


 
premium
number or null <double> 
No longer in use. Replaced by Premium Billing module.


 
sex
string or null  <= 1 characters 
No longer in use. Replaced by Premium Billing module.


 
tier
string or null  <= 2 characters 
No longer in use. Replaced by Premium Billing module.


 
update_Date
string <date-time> 
No longer in use. Replaced by Premium Billing module.


 
update_User
string or null  <= 20 characters 
No longer in use. Replaced by Premium Billing module.


 
Responses 
207
Success


401
Unauthorized


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