Group Contract Tiers

Create GroupContractTier

Creates a new GroupContractTier

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

header Parameters
vbasoftware-database
required
string

Target database

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

References GroupContract.Group_ID value on the parent record.

division_ID
required
string [ 1 .. 20 ] characters

References GroupContract.Division_ID value on the parent record.

coverage_Start
required
string <date-time>

References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

tier
required
string [ 1 .. 2 ] characters

The tier being offered during this contract. References Tiers.Tier value in referenced table.

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}/tiers
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "tier": "st",
  • "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 GroupContractTier

Lists all GroupContractTier for the given groupID and divisionID and coverageStart

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

coverageStart
required
string <date-time>

Coverage Start

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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
tier
required
string
Tier


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/tiers/{tier}
Request samples 
Response samples 
No sample
Update GroupContractTier
Updates a specific GroupContractTier.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
tier
required
string
Tier


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
coverage_Start
required
string <date-time> 
References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
tier
required
string  [ 1 .. 2 ] characters 
The tier being offered during this contract. References Tiers.Tier value in referenced table.


 
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}/tiers/{tier}
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "coverage_Start": "2019-08-24T14:15:22Z",
  • "tier": "st",
  • "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 GroupContractTier
Deletes an GroupContractTier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
coverageStart
required
string <date-time> 
Coverage Start


 
tier
required
string
Tier


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/tiers/{tier}
Request samples 
Create or Update Batch GroupContractTier
Create or Update multiple GroupContractTier 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


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
coverage_Start
required
string <date-time> 
References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
tier
required
string  [ 1 .. 2 ] characters 
The tier being offered during this contract. References Tiers.Tier value in referenced table.


 
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}/tiers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}