Explaination Code Categories

Create ExplanationCodeCategory

Creates a new ExplanationCodeCategory

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
category
required
string [ 1 .. 6 ] characters
description
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
invalid
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/explaination-code-categories
Request samples
{
  • "category": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invalid": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ExplanationCodeCategory

Lists all ExplanationCodeCategory

SecurityapiKeyAuth and bearerAuth
Request
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/explaination-code-categories
Request samples 
Response samples 
No sample
Get ExplanationCodeCategory
Gets ExplanationCodeCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
category
required
string
Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/explaination-code-categories/{category}
Request samples 
Response samples 
No sample
Update ExplanationCodeCategory
Updates a specific ExplanationCodeCategory.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
category
required
string
Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
category
required
string  [ 1 .. 6 ] characters 
 
description
string or null  <= 64 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
invalid
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/explaination-code-categories/{category}
Request samples 
{
  • "category": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invalid": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ExplanationCodeCategory
Deletes an ExplanationCodeCategory


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
category
required
string
Category


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/explaination-code-categories/{category}
Request samples 
Create or Update Batch ExplanationCodeCategory
Create or Update multiple ExplanationCodeCategory 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
required
string  [ 1 .. 6 ] characters 
 
description
string or null  <= 64 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
invalid
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/explaination-code-categories-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}