Group Classes

Create GroupClass

Creates a new GroupClass

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupDivisionClass_Key
required
integer <int32>

Unique identifier for each Claim record within this Group/Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.

cobra
required
boolean

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.

calc_Cov_By
string or null <= 8 characters

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

class_Code
required
string [ 1 .. 32 ] characters

The Class indicator assigned to this class record within the Group/Division setup.

division_ID
string or null <= 20 characters

References GroupDivision.Division_ID value on the parent record.

effective_Date
string or null <date-time>

Effective (Start) date of this Class on this Group/Division.

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.

group_ID
required
string [ 1 .. 20 ] characters

References GroupDivision.Group_ID value on the parent record.

max_Amount
number or null <double>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

max_Guaranteed_Issue
number or null <double>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

max_Volume
number or null <double>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

min_Amount
number or null <double>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

min_Volume
number or null <double>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

multiplier_Option
string or null <= 8 characters

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

pay_Freq
integer or null <int32>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

pay_Freq_Start
string or null <date-time>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

pay_Freq_Type
string or null <= 8 characters

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

plan_ID
string or null <= 20 characters

If this class definition is Plan specific then add a reference here to Plans.Plan_ID.

smart_Flex
required
boolean

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.

start_Date_Rule
string or null <= 8 characters

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

term_Date
string or null <date-time>

Term (End) date of this Class on this Group/Division.

term_Rule
string or null <= 8 characters

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

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.

volume_Increment
number or null <double>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

waiting_Period
integer or null <int32>

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

waiting_Period_Type
string or null <= 8 characters

Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/classes
Request samples
{
  • "groupDivisionClass_Key": 0,
  • "cobra": true,
  • "calc_Cov_By": "string",
  • "class_Code": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "max_Amount": 0.1,
  • "max_Guaranteed_Issue": 0.1,
  • "max_Volume": 0.1,
  • "min_Amount": 0.1,
  • "min_Volume": 0.1,
  • "multiplier_Option": "string",
  • "pay_Freq": 0,
  • "pay_Freq_Start": "2019-08-24T14:15:22Z",
  • "pay_Freq_Type": "string",
  • "plan_ID": "string",
  • "smart_Flex": true,
  • "start_Date_Rule": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "term_Rule": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume_Increment": 0.1,
  • "waiting_Period": 0,
  • "waiting_Period_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupClass

Lists all GroupClass for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group 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}/classes
Request samples 
Response samples 
No sample
Get GroupClass
Gets GroupClass


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupDivisionClassKey
required
integer <int32> 
GroupDivisionClass Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/classes/{groupDivisionClassKey}
Request samples 
Response samples 
No sample
Update GroupClass
Updates a specific GroupClass.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupDivisionClassKey
required
integer <int32> 
GroupDivisionClass Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupDivisionClass_Key
required
integer <int32> 
Unique identifier for each Claim record within this Group/Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cobra
required
boolean
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Cov_By
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
class_Code
required
string  [ 1 .. 32 ] characters 
The Class indicator assigned to this class record within the Group/Division setup.


 
division_ID
string or null  <= 20 characters 
References GroupDivision.Division_ID value on the parent record.


 
effective_Date
string or null <date-time> 
Effective (Start) date of this Class on this Group/Division.


 
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.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
max_Amount
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
max_Guaranteed_Issue
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
max_Volume
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
min_Amount
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
min_Volume
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
multiplier_Option
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
pay_Freq
integer or null <int32> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
pay_Freq_Start
string or null <date-time> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
pay_Freq_Type
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
plan_ID
string or null  <= 20 characters 
If this class definition is Plan specific then add a reference here to Plans.Plan_ID.


 
smart_Flex
required
boolean
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
start_Date_Rule
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
term_Date
string or null <date-time> 
Term (End) date of this Class on this Group/Division.


 
term_Rule
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
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.


 
volume_Increment
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
waiting_Period
integer or null <int32> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
waiting_Period_Type
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/classes/{groupDivisionClassKey}
Request samples 
{
  • "groupDivisionClass_Key": 0,
  • "cobra": true,
  • "calc_Cov_By": "string",
  • "class_Code": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "max_Amount": 0.1,
  • "max_Guaranteed_Issue": 0.1,
  • "max_Volume": 0.1,
  • "min_Amount": 0.1,
  • "min_Volume": 0.1,
  • "multiplier_Option": "string",
  • "pay_Freq": 0,
  • "pay_Freq_Start": "2019-08-24T14:15:22Z",
  • "pay_Freq_Type": "string",
  • "plan_ID": "string",
  • "smart_Flex": true,
  • "start_Date_Rule": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "term_Rule": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume_Increment": 0.1,
  • "waiting_Period": 0,
  • "waiting_Period_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupClass
Deletes an GroupClass


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupDivisionClassKey
required
integer <int32> 
GroupDivisionClass Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/classes/{groupDivisionClassKey}
Request samples 
Create or Update Batch GroupClass
Create or Update multiple GroupClass 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupDivisionClass_Key
required
integer <int32> 
Unique identifier for each Claim record within this Group/Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
cobra
required
boolean
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Cov_By
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
class_Code
required
string  [ 1 .. 32 ] characters 
The Class indicator assigned to this class record within the Group/Division setup.


 
division_ID
string or null  <= 20 characters 
References GroupDivision.Division_ID value on the parent record.


 
effective_Date
string or null <date-time> 
Effective (Start) date of this Class on this Group/Division.


 
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.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupDivision.Group_ID value on the parent record.


 
max_Amount
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
max_Guaranteed_Issue
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
max_Volume
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
min_Amount
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
min_Volume
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
multiplier_Option
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
pay_Freq
integer or null <int32> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
pay_Freq_Start
string or null <date-time> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
pay_Freq_Type
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
plan_ID
string or null  <= 20 characters 
If this class definition is Plan specific then add a reference here to Plans.Plan_ID.


 
smart_Flex
required
boolean
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
start_Date_Rule
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
term_Date
string or null <date-time> 
Term (End) date of this Class on this Group/Division.


 
term_Rule
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
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.


 
volume_Increment
number or null <double> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
waiting_Period
integer or null <int32> 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
waiting_Period_Type
string or null  <= 8 characters 
Informational used in custom reporting for Life & Disability clients who have an additional "Class" structure under Division.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/classes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}