Skip to content

Create PlanBenCodeSpecialty

Request

Creates a new PlanBenCodeSpecialty

Security
apiKeyAuth and bearerAuth
Path
planIDstringrequired

Plan ID

benefitCodestringrequired

Benefit Code

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
plan_IDstring, [ 1 .. 20 ] charactersrequired

References the PlanBenefits.Plan_ID value in parent table.

benefit_Codestring, [ 1 .. 10 ] charactersrequired

References the PlanBenefits.Benefit_Code value in parent table.

specialty_Codestring, [ 1 .. 10 ] charactersrequired

Specifies the Provider specialty that the User wishes to either include or exclude as part of the benefit on top of the system-wide definition of the benefit.

entry_Datestring, (date-time)

Date when the record was added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

excludebooleanrequired

Indicates whether the specified code is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits/{benefitCode}/specialties' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "plan_ID": "string",
    "benefit_Code": "string",
    "specialty_Code": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "exclude": true,
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}