Benefit Procedures

Create BenefitProcedures

Creates a new BenefitProcedures

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
benefit_Code
required
string [ 1 .. 10 ] characters

References the BenefitCodes.Benefit_Code from the parent table.

from_Procedure
required
string [ 1 .. 8 ] characters

First Procedure Code for the specified range.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

exclude
required
boolean

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_Procedure
string or null <= 8 characters

No longer in use.

override_Thru_Procedure
string or null <= 8 characters

No longer in use.

thru_Procedure
string or null <= 8 characters

Last Procedure Code for the specified range.

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/benefits/{benefitCode}/procedures
Request samples
{
  • "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"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List BenefitProcedures

Lists all BenefitProcedures benefitCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
benefitCode
required
string

Benefit Code

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/benefits/{benefitCode}/procedures
Request samples 
Response samples 
No sample
Get BenefitProcedures
Gets BenefitProcedures


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/benefits/{benefitCode}/procedures/{fromProcedure}
Request samples 
Response samples 
No sample
Update BenefitProcedures
Updates a specific BenefitProcedures.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the BenefitCodes.Benefit_Code from the parent table.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
First Procedure Code for the specified range.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
exclude
required
boolean
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_Procedure
string or null  <= 8 characters 
No longer in use.


 
override_Thru_Procedure
string or null  <= 8 characters 
No longer in use.


 
thru_Procedure
string or null  <= 8 characters 
Last Procedure Code for the specified range.


 
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/benefits/{benefitCode}/procedures/{fromProcedure}
Request samples 
{
  • "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"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete BenefitProcedures
Deletes an BenefitProcedures


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
benefitCode
required
string
Benefit Code


 
fromProcedure
required
string
From Procedure


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/benefits/{benefitCode}/procedures/{fromProcedure}
Request samples 
Create or Update Batch BenefitProcedures
Create or Update multiple BenefitProcedures 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
benefitCode
required
string
Benefit Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
benefit_Code
required
string  [ 1 .. 10 ] characters 
References the BenefitCodes.Benefit_Code from the parent table.


 
from_Procedure
required
string  [ 1 .. 8 ] characters 
First Procedure Code for the specified range.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
exclude
required
boolean
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_Procedure
string or null  <= 8 characters 
No longer in use.


 
override_Thru_Procedure
string or null  <= 8 characters 
No longer in use.


 
thru_Procedure
string or null  <= 8 characters 
Last Procedure Code for the specified range.


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