Occupations

Create Occupation

Creates a new Occupation

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
occupation_ID
required
string [ 1 .. 32 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
occupation_Description
string or null
occupation_Display
string or null <= 128 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/occupations
Request samples
{
  • "occupation_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "occupation_Description": "string",
  • "occupation_Display": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Occupation

Lists all Occupation

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/occupations
Request samples
Response samples
No sample

Get Occupation

Gets Occupation

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
occupationID
required
string

Occupation ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/occupations/{occupationID}
Request samples
Response samples
No sample

Update Occupation

Updates a specific Occupation.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
occupationID
required
string

Occupation ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
occupation_ID
required
string [ 1 .. 32 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
occupation_Description
string or null
occupation_Display
string or null <= 128 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/occupations/{occupationID}
Request samples
{
  • "occupation_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "occupation_Description": "string",
  • "occupation_Display": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete Occupation

Deletes an Occupation

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
occupationID
required
string

Occupation ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/occupations/{occupationID}
Request samples

Create or Update Batch Occupation

Create or Update multiple Occupation 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
occupation_ID
required
string [ 1 .. 32 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
occupation_Description
string or null
occupation_Display
string or null <= 128 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

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