Plan Benefit Clusters

Create PlanBenefitCluster

Creates a new PlanBenefitCluster

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planBenefitCluster_Key
required
integer <int32>

Identity column for table PlanBenefitCluster Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

benefit_Code
required
string [ 1 .. 10 ] characters

Which Benefit Code is the base code for this Plan Benefit Cluster

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

multiTier_1
string or null <= 10 characters

First Multitier for the Benefit Code listed under this Plan Benefit Cluster

multiTier_2
string or null <= 10 characters

Second Multitier for the Benefit Code listed under this Plan Benefit Cluster

multiTier_3
string or null <= 10 characters

Third Multitier for the Benefit Code listed under this Plan Benefit Cluster

multiTier_4
string or null <= 10 characters

Fourth Multitier for the Benefit Code listed under this Plan Benefit Cluster

multiTier_5
string or null <= 10 characters

Fifth Multitier for the Benefit Code listed under this Plan Benefit Cluster

plan_ID
required
string [ 1 .. 20 ] characters

Which Plan this Plan Benefit Cluster belongs to

update_Date
string <date-time>

Date 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/plan-benefit-clusters
Request samples
{
  • "planBenefitCluster_Key": 0,
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "multiTier_1": "string",
  • "multiTier_2": "string",
  • "multiTier_3": "string",
  • "multiTier_4": "string",
  • "multiTier_5": "string",
  • "plan_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefitCluster

Lists all PlanBenefitCluster

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
planId
string

Plan ID

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/plan-benefit-clusters
Request samples 
Response samples 
No sample
Get PlanBenefitCluster
Gets PlanBenefitCluster


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planBenefitClusterKey
required
integer <int32> 
PlanBenefitCluster Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plan-benefit-clusters/{planBenefitClusterKey}
Request samples 
Response samples 
No sample
Update PlanBenefitCluster
Updates a specific PlanBenefitCluster.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planBenefitClusterKey
required
integer <int32> 
PlanBenefitCluster Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planBenefitCluster_Key
required
integer <int32> 
Identity column for table PlanBenefitCluster  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Which Benefit Code is the base code for this Plan Benefit Cluster


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
multiTier_1
string or null  <= 10 characters 
First Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_2
string or null  <= 10 characters 
Second Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_3
string or null  <= 10 characters 
Third Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_4
string or null  <= 10 characters 
Fourth Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_5
string or null  <= 10 characters 
Fifth Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Which Plan this Plan Benefit Cluster belongs to


 
update_Date
string <date-time> 
Date 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/plan-benefit-clusters/{planBenefitClusterKey}
Request samples 
{
  • "planBenefitCluster_Key": 0,
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "multiTier_1": "string",
  • "multiTier_2": "string",
  • "multiTier_3": "string",
  • "multiTier_4": "string",
  • "multiTier_5": "string",
  • "plan_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenefitCluster
Deletes an PlanBenefitCluster


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planBenefitClusterKey
required
integer <int32> 
PlanBenefitCluster Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plan-benefit-clusters/{planBenefitClusterKey}
Request samples 
Create or Update Batch PlanBenefitCluster
Create or Update multiple PlanBenefitCluster 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 
planBenefitCluster_Key
required
integer <int32> 
Identity column for table PlanBenefitCluster  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Which Benefit Code is the base code for this Plan Benefit Cluster


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
multiTier_1
string or null  <= 10 characters 
First Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_2
string or null  <= 10 characters 
Second Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_3
string or null  <= 10 characters 
Third Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_4
string or null  <= 10 characters 
Fourth Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
multiTier_5
string or null  <= 10 characters 
Fifth Multitier for the Benefit Code listed under this Plan Benefit Cluster


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Which Plan this Plan Benefit Cluster belongs to


 
update_Date
string <date-time> 
Date 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/plan-benefit-clusters-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}