Procedure Categories

Create ProcedureCategory

Creates a new ProcedureCategory

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
category_ID
required
string [ 1 .. 32 ] characters

Name of the 'Procedure Category'.

description
string or null <= 128 characters

Description of the 'Procedure Category'.

entry_Date
string <date-time>

Date record was first 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 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/procedure-categories
Request samples
{
  • "category_ID": "string",
  • "description": "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 ProcedureCategory

Lists all ProcedureCategory given a specific

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/procedure-categories
Request samples 
Response samples 
No sample
Get ProcedureCategory
Gets ProcedureCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
categoryID
required
string
Category ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/procedure-categories/{categoryID}
Request samples 
Response samples 
No sample
Update ProcedureCategory
Updates a specific ProcedureCategory.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
categoryID
required
string
Category ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
category_ID
required
string  [ 1 .. 32 ] characters 
Name of the 'Procedure Category'.


 
description
string or null  <= 128 characters 
Description of the 'Procedure Category'.


 
entry_Date
string <date-time> 
Date record was first 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 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/procedure-categories/{categoryID}
Request samples 
{
  • "category_ID": "string",
  • "description": "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 ProcedureCategory
Deletes an ProcedureCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
categoryID
required
string
Category ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/procedure-categories/{categoryID}
Request samples 
Create or Update Batch ProcedureCategory
Create or Update multiple ProcedureCategory at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
category_ID
required
string  [ 1 .. 32 ] characters 
Name of the 'Procedure Category'.


 
description
string or null  <= 128 characters 
Description of the 'Procedure Category'.


 
entry_Date
string <date-time> 
Date record was first 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 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/procedure-categories-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}