Plan Benefit Place Ex Codes

Create PlanBenefitsPlace

Creates a new PlanBenefitsPlace

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

benefit_Code
required
string [ 1 .. 10 ] characters

References the PlanBenefits.Benefit_Code value in parent table.

place_Code
required
string [ 1 .. 4 ] characters

This allows the User to apply the speecified Ex Code to any claims containing the selected place code.

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.

ex_Code
string or null <= 6 characters

This is the Ex Code that will be applied to any claims containing the selected place code.

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}/place-ex-codes
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefitsPlace

Lists all PlanBenefitsPlace 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}/place-ex-codes
Request samples 
Response samples 
No sample
Get PlanBenefitsPlace
Gets PlanBenefitsPlace


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/benefits/{benefitCode}/place-ex-codes/{placeCode}
Request samples 
Response samples 
No sample
Update PlanBenefitsPlace
Updates a specific PlanBenefitsPlace.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


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


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


 
place_Code
required
string  [ 1 .. 4 ] characters 
This allows the User to apply the speecified Ex Code to any claims containing the selected place code.


 
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.


 
ex_Code
string or null  <= 6 characters 
This is the Ex Code that will be applied to any claims containing the selected place code.


 
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}/place-ex-codes/{placeCode}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenefitsPlace
Deletes an PlanBenefitsPlace


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
placeCode
required
string
Place Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/benefits/{benefitCode}/place-ex-codes/{placeCode}
Request samples 
Create or Update Batch PlanBenefitsPlace
Create or Update multiple PlanBenefitsPlace 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 PlanBenefits.Plan_ID value in parent table.


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


 
place_Code
required
string  [ 1 .. 4 ] characters 
This allows the User to apply the speecified Ex Code to any claims containing the selected place code.


 
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.


 
ex_Code
string or null  <= 6 characters 
This is the Ex Code that will be applied to any claims containing the selected place code.


 
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}/place-ex-codes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}