Plan Auth Penalty Benefits

Create PlanAuthPenaltyBenefit

Creates a new PlanAuthPenaltyBenefit

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

planAuthPenaltyKey
required
integer <int32>

PlanAuthPenalty Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planAuthPenalty_Key
required
integer <int32>

References the PlanAuthPenalty.PlanAuthPenalty_Key value in parent table.

benefit_Code
required
string [ 1 .. 10 ] characters

Identifies the Benefit Codes that are applied to the Auth Penalty.

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.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits
Request samples
{
  • "planAuthPenalty_Key": 0,
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanAuthPenaltyBenefit

Lists all PlanAuthPenaltyBenefit for the given planAuthPenaltyKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

planAuthPenaltyKey
required
integer <int32>

PlanAuthPenalty Key

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits
Request samples 
Response samples 
No sample
Get PlanAuthPenaltyBenefit
Gets PlanAuthPenaltyBenefit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planAuthPenaltyKey
required
integer <int32> 
PlanAuthPenalty Key


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits/{benefitCode}
Request samples 
Response samples 
No sample
Update PlanAuthPenaltyBenefit
Updates a specific PlanAuthPenaltyBenefit.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planAuthPenaltyKey
required
integer <int32> 
PlanAuthPenalty Key


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planAuthPenalty_Key
required
integer <int32> 
References the PlanAuthPenalty.PlanAuthPenalty_Key value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Identifies the Benefit Codes that are applied to the Auth Penalty.


 
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.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits/{benefitCode}
Request samples 
{
  • "planAuthPenalty_Key": 0,
  • "benefit_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanAuthPenaltyBenefit
Deletes an PlanAuthPenaltyBenefit


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planAuthPenaltyKey
required
integer <int32> 
PlanAuthPenalty Key


 
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits/{benefitCode}
Request samples 
Create or Update Batch PlanAuthPenaltyBenefit
Create or Update multiple PlanAuthPenaltyBenefit 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


 
planAuthPenaltyKey
required
integer <int32> 
PlanAuthPenalty Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
planAuthPenalty_Key
required
integer <int32> 
References the PlanAuthPenalty.PlanAuthPenalty_Key value in parent table.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Identifies the Benefit Codes that are applied to the Auth Penalty.


 
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.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/auth-penalties/{planAuthPenaltyKey}/benefits-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}