Plan Accumulator Benefits

Create PlanAddedAccumBenefits

Creates a new PlanAddedAccumBenefits

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

accumName
required
string

Accum Name

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

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

References the PlanAddedAccum.Plan_ID for this Added Accumulator.

accum_Name
required
string [ 1 .. 10 ] characters

References the PlanAddedAccum.Accum_Name for this Added Accumulator.

benefit_Code
required
string [ 1 .. 10 ] characters

References the BenefitCodes.Benefit_Code for this Added Accumulator.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/accumulators/{accumName}/benefits/{benefitCode}
Request samples
{
  • "plan_ID": "string",
  • "accum_Name": "string",
  • "benefit_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get PlanAddedAccumBenefits

Gets PlanAddedAccumBenefits

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

accumName
required
string

Accum Name

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/accumulators/{accumName}/benefits/{benefitCode}
Request samples 
Response samples 
No sample
Delete PlanAddedAccumBenefits
Deletes an PlanAddedAccumBenefits


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
accumName
required
string
Accum Name


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/accumulators/{accumName}/benefits/{benefitCode}
Request samples 
List PlanAddedAccumBenefits
Lists all PlanAddedAccumBenefits planID,accumName


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
accumName
required
string
Accum Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/accumulators/{accumName}/benefits
Request samples 
Response samples 
No sample
Create Batch PlanAddedAccumBenefits
Create multiple PlanAddedAccumBenefits at once.  If the entity exists, an error message will be added to the response.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
accumName
required
string
Accum Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the PlanAddedAccum.Plan_ID for this Added Accumulator.


 
accum_Name
required
string  [ 1 .. 10 ] characters 
References the PlanAddedAccum.Accum_Name for this Added Accumulator.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the BenefitCodes.Benefit_Code for this Added Accumulator.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/accumulators/{accumName}/benefits-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}