Plan Benefit Cascades

Create PlanBenefitCascade

Creates a new PlanBenefitCascade

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

parentBenefitCode
required
string

Parent Benefit Code

cascadeBenefitCode
required
string
header Parameters
vbasoftware-database
required
string

Target database

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

Unique identifier assigned to the Plan.

parent_Benefit_Code
required
string [ 1 .. 10 ] characters

Originating Benefit Code of the cascading benefit.

cascade_Benefit_Code
required
string [ 1 .. 10 ] characters

Target Benefit Code of the cascading benefit.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/parent-benefits/{parentBenefitCode}/cascade-benefits/{cascadeBenefitCode}
Request samples
{
  • "plan_ID": "string",
  • "parent_Benefit_Code": "string",
  • "cascade_Benefit_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get PlanBenefitCascade

Gets PlanBenefitCascade

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

parentBenefitCode
required
string

Parent Benefit Code

cascadeBenefitCode
required
string

Cascade Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/parent-benefits/{parentBenefitCode}/cascade-benefits/{cascadeBenefitCode}
Request samples 
Response samples 
No sample
Delete PlanBenefitCascade
Deletes an PlanBenefitCascade


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
parentBenefitCode
required
string
Parent Benefit Code


 
cascadeBenefitCode
required
string
Cascade Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/parent-benefits/{parentBenefitCode}/cascade-benefits/{cascadeBenefitCode}
Request samples 
List PlanBenefitCascade
Lists all PlanBenefitCascade for the given planID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/cascade-benefits
Request samples 
Response samples 
No sample
Create or Update Batch PlanBenefitCascade
Create or Update multiple PlanBenefitCascade 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
planID
required
string
Plan ID


 
parentBenefitCode
required
string
Parent Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
plan_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the Plan.


 
parent_Benefit_Code
required
string  [ 1 .. 10 ] characters 
Originating Benefit Code of the cascading benefit.


 
cascade_Benefit_Code
required
string  [ 1 .. 10 ] characters 
Target Benefit Code of the cascading benefit.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/parent-benefits/{parentBenefitCode}/cascade-benefits
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}