Languages

Create Languages

Creates a new Languages

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
language_ID
required
string [ 1 .. 8 ] characters

Identifier for the language

description
string or null <= 500 characters

Description string for the language used in reports

display
string or null <= 200 characters

Display string for the language used in lists

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/languages
Request samples
{
  • "language_ID": "string",
  • "description": "string",
  • "display": "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 Languages

Lists all Languages

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/languages
Request samples 
Response samples 
No sample
Get Languages
Gets Languages


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/languages/{languageID}
Request samples 
Response samples 
No sample
Update Languages
Updates a specific Languages.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
language_ID
required
string  [ 1 .. 8 ] characters 
Identifier for the language


 
description
string or null  <= 500 characters 
Description string for the language used in reports


 
display
string or null  <= 200 characters 
Display string for the language used in lists


 
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/languages/{languageID}
Request samples 
{
  • "language_ID": "string",
  • "description": "string",
  • "display": "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 Languages
Deletes an Languages


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
languageID
required
string
Language ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/languages/{languageID}
Request samples 
Create or Update Batch Languages
Create or Update multiple Languages 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 
language_ID
required
string  [ 1 .. 8 ] characters 
Identifier for the language


 
description
string or null  <= 500 characters 
Description string for the language used in reports


 
display
string or null  <= 200 characters 
Display string for the language used in lists


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