Plan Benefit Tooth Maximums

Create PlanMaximumTooth

Creates a new PlanMaximumTooth

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
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.

tooth_Number
required
integer <int32>

Defines each tooth to include in the Maximum

Responses
200

Success

401

Unauthorized

post/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/teeth
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "max_ID": "string",
  • "tooth_Number": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanMaximumTooth

Lists all PlanMaximumTooth 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}/teeth
Request samples
Response samples
No sample

Get PlanMaximumTooth

Gets PlanMaximumTooth

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max ID

toothNumber
required
integer <int32>

Tooth Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/teeth/{toothNumber}
Request samples
Response samples
No sample

Delete PlanMaximumTooth

Deletes an PlanMaximumTooth

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

maxID
required
string

Max ID

toothNumber
required
integer <int32>

Tooth Number

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/plans/{planID}/benefits/{benefitCode}/maximums/{maxID}/teeth/{toothNumber}
Request samples

Create or Update Batch PlanMaximumTooth

Create or Update multiple PlanMaximumTooth 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.

tooth_Number
required
integer <int32>

Defines each tooth to include in the Maximum

Responses
207

Success

401

Unauthorized

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