Plan Benefit Procedure Ex Codes

Create PlanBenefitsProcedures

Creates a new PlanBenefitsProcedures

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

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 PlanBenefitsPlace.Plan_ID value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanBenefitsPlace.Benefit_Code value in parent table.

procedure_Code
required
string [ 1 .. 8 ] characters

References the PlanBenefitsPlace.Place_Code value in parent table.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

pend_Ex_Code
required
string [ 1 .. 6 ] characters

Ex Code that will be applied to the designated range of procedure codes.

procedure_Code_Thru
string or null <= 8 characters

End of the range of procedure codes that the selected Ex Code will apply to.

update_Date
string <date-time>

Date when 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/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "procedure_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "pend_Ex_Code": "string",
  • "procedure_Code_Thru": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefitsProcedures

Lists all PlanBenefitsProcedures for the given planID and benefitCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes
Request samples 
Response samples 
No sample
Get PlanBenefitsProcedures
Gets PlanBenefitsProcedures


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
procedureCode
required
string
Procedure Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes/{procedureCode}
Request samples 
Response samples 
No sample
Update PlanBenefitsProcedures
Updates a specific PlanBenefitsProcedures.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
procedureCode
required
string
Procedure Code


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
procedure_Code
required
string  [ 1 .. 8 ] characters 
References the PlanBenefitsPlace.Place_Code value in parent table.


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


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


 
pend_Ex_Code
required
string  [ 1 .. 6 ] characters 
Ex Code that will be applied to the designated range of procedure codes.


 
procedure_Code_Thru
string or null  <= 8 characters 
End of the range of procedure codes that the selected Ex Code will apply to.


 
update_Date
string <date-time> 
Date when 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/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes/{procedureCode}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "procedure_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "pend_Ex_Code": "string",
  • "procedure_Code_Thru": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenefitsProcedures
Deletes an PlanBenefitsProcedures


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
procedureCode
required
string
Procedure Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes/{procedureCode}
Request samples 
Create or Update Batch PlanBenefitsProcedures
Create or Update multiple PlanBenefitsProcedures 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


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
procedure_Code
required
string  [ 1 .. 8 ] characters 
References the PlanBenefitsPlace.Place_Code value in parent table.


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


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


 
pend_Ex_Code
required
string  [ 1 .. 6 ] characters 
Ex Code that will be applied to the designated range of procedure codes.


 
procedure_Code_Thru
string or null  <= 8 characters 
End of the range of procedure codes that the selected Ex Code will apply to.


 
update_Date
string <date-time> 
Date when 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/plans/{planID}/benefits/{benefitCode}/procedure-ex-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}