Tiers

Create Tier

Creates a new Tier

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
tier1
required
string [ 1 .. 2 ] characters

Identifier for the specific tier

dependent
required
boolean

Flag indicating the tier includes any dependents

description
string or null <= 20 characters

Description of the specific tier

hipaA_Code
string or null <= 8 characters

Code used by HIPAA to identify the specific tier

insured
required
boolean

Flag indicating the tier includes the insured

max_Members
integer or null <int32>

Maximum total members the tier allows.

multimember_Tier
required
boolean

Flag indicating the tier allows multiple members

spouse
required
boolean

Flag indicating the tier includes the spouse

spouse_Only
string or null <= 1 characters

Flag indicating the tier includes only the spouse

Responses
200

Success

401

Unauthorized

post/tiers
Request samples
{
  • "tier1": "st",
  • "dependent": true,
  • "description": "string",
  • "hipaA_Code": "string",
  • "insured": true,
  • "max_Members": 0,
  • "multimember_Tier": true,
  • "spouse": true,
  • "spouse_Only": "s"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Tier

Lists all Tier

SecurityapiKeyAuth and bearerAuth
Request
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/tiers
Request samples 
Response samples 
No sample
Get Tier
Gets Tier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
tier1
required
string
Tier1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/tiers/{tier1}
Request samples 
Response samples 
No sample
Update Tier
Updates a specific Tier.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
tier1
required
string
Tier1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
tier1
required
string  [ 1 .. 2 ] characters 
Identifier for the specific tier


 
dependent
required
boolean
Flag indicating the tier includes any dependents


 
description
string or null  <= 20 characters 
Description of the specific tier


 
hipaA_Code
string or null  <= 8 characters 
Code used by HIPAA to identify the specific tier


 
insured
required
boolean
Flag indicating the tier includes the insured


 
max_Members
integer or null <int32> 
Maximum total members the tier allows.


 
multimember_Tier
required
boolean
Flag indicating the tier allows multiple members


 
spouse
required
boolean
Flag indicating the tier includes the spouse


 
spouse_Only
string or null  <= 1 characters 
Flag indicating the tier includes only the spouse


 
Responses 
200
Success


401
Unauthorized


put/tiers/{tier1}
Request samples 
{
  • "tier1": "st",
  • "dependent": true,
  • "description": "string",
  • "hipaA_Code": "string",
  • "insured": true,
  • "max_Members": 0,
  • "multimember_Tier": true,
  • "spouse": true,
  • "spouse_Only": "s"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Tier
Deletes an Tier


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
tier1
required
string
Tier1


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/tiers/{tier1}
Request samples 
Create or Update Batch Tier
Create or Update multiple Tier at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
tier1
required
string  [ 1 .. 2 ] characters 
Identifier for the specific tier


 
dependent
required
boolean
Flag indicating the tier includes any dependents


 
description
string or null  <= 20 characters 
Description of the specific tier


 
hipaA_Code
string or null  <= 8 characters 
Code used by HIPAA to identify the specific tier


 
insured
required
boolean
Flag indicating the tier includes the insured


 
max_Members
integer or null <int32> 
Maximum total members the tier allows.


 
multimember_Tier
required
boolean
Flag indicating the tier allows multiple members


 
spouse
required
boolean
Flag indicating the tier includes the spouse


 
spouse_Only
string or null  <= 1 characters 
Flag indicating the tier includes only the spouse


 
Responses 
207
Success


401
Unauthorized


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