Skip to content
/
Create or Update Batch Pl...

Create or Update Batch PlanBenCodeProcCode

Request

Create or Update multiple PlanBenCodeProcCode at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

Security
apiKeyAuth and bearerAuth
Path
planIDstringrequired

Plan ID

benefitCodestringrequired

Benefit Code

Headers
vbasoftware-databasestringrequired

Target database

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

References the PlanBenefits.Plan_ID value in parent table.

benefit_Codestring, [ 1 .. 50 ] charactersrequired

References the PlanBenefits.Benefit_Code value in parent table.

from_Procedurestring, [ 1 .. 8 ] charactersrequired

First Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this 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 range of codes is included or excluded. Note: This field is marked as NOT NULL in the database and therefore required by the API.

override_From_Procedurestring or null, <= 8 characters

No longer in use.

override_Thru_Procedurestring or null, <= 8 characters

No longer in use.

thru_Procedurestring or null, <= 8 characters

Last Procedure Code for the specified range. This range allows the User to apply additional codes on top of the system-wide definition of codes for this benefit.

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 PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/plans/{planID}/benefits/{benefitCode}/procedure-codes-batch' \
  -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",
      "from_Procedure": "string",
      "entry_Date": "2019-08-24T14:15:22Z",
      "entry_User": "string",
      "exclude": true,
      "override_From_Procedure": "string",
      "override_Thru_Procedure": "string",
      "thru_Procedure": "string",
      "update_Date": "2019-08-24T14:15:22Z",
      "update_User": "string"
    }
  ]'

Responses

Success

Bodyapplication/json
dataArray of objects or null
errorobject
debugobject
Response
{
  "data": [ … ],
  "error": { … },
  "debug": { … }
}