Plan Benefit Maximums

Create PlanMaximumBenefit

Creates a new PlanMaximumBenefit

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max ID

includedBenefitCode
required
string

Included Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

post/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits/{includedBenefitCode}
Request samples 
Response samples 
No sample
Get PlanMaximumBenefit
Gets PlanMaximumBenefit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
includedBenefitCode
required
string
Included Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits/{includedBenefitCode}
Request samples 
Response samples 
No sample
Delete PlanMaximumBenefit
Deletes an PlanMaximumBenefit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
includedBenefitCode
required
string
Included Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits/{includedBenefitCode}
Request samples 
List PlanMaximumBenefit
Lists all PlanMaximumBenefit for the given planID and benefitCode and maxID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits
Request samples 
Response samples 
No sample
Create or Update Batch PlanMaximumBenefit
Create or Update multiple PlanMaximumBenefit 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


 
benefitCode
required
string
Benefit Code


 
maxID
required
string
Max ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the PlanMaximum.Plan_ID value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the PlanMaximum.Benefit_Code value in parent table.


 
max_ID
required
string  [ 1 .. 10 ] characters 
References the PlanMaximum.Max_ID value in the parent table.


 
included_Benefit_Code
required
string  [ 1 .. 20 ] characters 
Additional Benefit Code included in the Maximum.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/included-benefits-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}