Plan Benefit Place Authorizations

Create PlanBenefitsPlaceAuth

Creates a new PlanBenefitsPlaceAuth

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.

place_Code
required
string [ 1 .. 4 ] characters

References the PlanBenefitsPlace.Place_Code value in parent table.

amount_Before_Auth
number or null <double>

Specifies the amount of the associated amount type that is allowed before requiring an authorization.

amount_Type
string or null <= 16 characters

Specifies the amount type (Billed, Allowed, or Payable) that the 'Amount Before Auth' rule will be tied to.

auth_Reqd
required
string = 1 characters

Indicates whether an authorization is required for the selected place code. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

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.

visits_Before_Auth
integer or null <int32>

Specifies the number of visits allowed before an authorization is required.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/benefits/{benefitCode}/place-auths
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "amount_Before_Auth": 0.1,
  • "amount_Type": "string",
  • "auth_Reqd": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "visits_Before_Auth": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanBenefitsPlaceAuth

Lists all PlanBenefitsPlaceAuth 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-auths
Request samples 
Response samples 
No sample
Get PlanBenefitsPlaceAuth
Gets PlanBenefitsPlaceAuth


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-auths/{placeCode}
Request samples 
Response samples 
No sample
Update PlanBenefitsPlaceAuth
Updates a specific PlanBenefitsPlaceAuth.


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


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


 
place_Code
required
string  [ 1 .. 4 ] characters 
References the PlanBenefitsPlace.Place_Code value in parent table.


 
amount_Before_Auth
number or null <double> 
Specifies the amount of the associated amount type that is allowed before requiring an authorization.


 
amount_Type
string or null  <= 16 characters 
Specifies the amount type (Billed, Allowed, or Payable) that the 'Amount Before Auth' rule will be tied to.


 
auth_Reqd
required
string  = 1 characters 
Indicates whether an authorization is required for the selected place code. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
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.


 
visits_Before_Auth
integer or null <int32> 
Specifies the number of visits allowed before an authorization is required.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/benefits/{benefitCode}/place-auths/{placeCode}
Request samples 
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "place_Code": "stri",
  • "amount_Before_Auth": 0.1,
  • "amount_Type": "string",
  • "auth_Reqd": "s",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "visits_Before_Auth": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanBenefitsPlaceAuth
Deletes an PlanBenefitsPlaceAuth


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-auths/{placeCode}
Request samples 
Create or Update Batch PlanBenefitsPlaceAuth
Create or Update multiple PlanBenefitsPlaceAuth 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.


 
place_Code
required
string  [ 1 .. 4 ] characters 
References the PlanBenefitsPlace.Place_Code value in parent table.


 
amount_Before_Auth
number or null <double> 
Specifies the amount of the associated amount type that is allowed before requiring an authorization.


 
amount_Type
string or null  <= 16 characters 
Specifies the amount type (Billed, Allowed, or Payable) that the 'Amount Before Auth' rule will be tied to.


 
auth_Reqd
required
string  = 1 characters 
Indicates whether an authorization is required for the selected place code. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
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.


 
visits_Before_Auth
integer or null <int32> 
Specifies the number of visits allowed before an authorization is required.


 
Responses 
207
Success


401
Unauthorized


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