Get Languages
post
/config/sim/v1/setup/getLanguages
Gets all the languages
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-OrgShortName: string
The ShortName of the organization
Language Get Request Body
Root Schema : LanguageGetRequestBody
Type:
Show Source
object-
include(optional):
string
Example:
locations -
languages(optional):
string
If specified, limits translated strings returned.Example:
en-US, es-SS,lt-LT -
limit(optional):
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset(optional):
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy(optional):
string
Sorts the response by the specified field name and sort order.Example:
items.objectNum:asc -
searchCriteria(optional):
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Language objects of the organization
Root Schema : LanguageGetResponse
Type:
Show Source
object-
count(optional):
integer
Current response recount count.Example:
9 -
hasMore(optional):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(optional):
array items
Array of language objects of the organization.
-
limit(optional):
integer
Server page sizeExample:
10 -
offset(optional):
integer
Starting resource record indexExample:
0 -
totalResults(optional):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of language objects of the organization.
Show Source
-
Array of:
object LanguageResourceObject
Model for Language Object
Nested Schema : LanguageResourceObject
Type:
objectModel for Language Object
Show Source
-
compareFlag(optional):
integer
This field is used for comparison of strings when strings are to be sorted.Example:
1 -
customerDisplayFont(optional):
string
The font for the customer display.
-
customNumerals(optional):
string
The digit to print in place of the value shown. Leave blank to use the hard-coded values shown.Example:
0123456789 -
keyBoardLayoutName(optional):
object keyBoardLayoutName
The name of the keyboard layout
-
keyboardLayoutObjNum(optional):
integer
The object number of the keyboard layoutExample:
1033 -
languageCulture(optional):
string
The abbreviated language code.Example:
en-US -
localeId(optional):
integer
The Microsoft defined locale ID.Example:
1033 -
localeKey(optional):
string
A unique key that is used to identify the language in the content and configuration API.Example:
en-US -
localeString(optional):
string
The language string.Example:
English (US) -
mappingFont(optional):
string
Use Vmap for Thai and Japanese. Use Amap otherwise.Example:
Amap -
name:
object name
name of the language
-
objectNum:
integer
Object Number of the language.Example:
1 -
printOptions(optional):
string
A string value of 0???s & 1???s representing the enablement or disablement of the print options associated with the language.Example:
00000000 -
printOptionsExt(optional):
array printOptionsExt
An object containing the descriptive print options list associated with the language.
-
reportFont(optional):
string
The font to use for the language in the Extensible Client local reports.
-
reportFontSize(optional):
integer
The font size to use for the language in the Extensible Client local reports.Example:
23 -
reverseWOrientation(optional):
boolean
A Boolean flag to using Hebrew language in printing. Setting this option will reverse the order of the characters in the word so that the words read correctly.Example:
false -
rightToLeftOrientation(optional):
boolean
A Boolean flag indicating to have the check detail area and customer receipts appear in right-to-left orientation.Example:
false -
textFileConfigurations(optional):
array textFileConfigurations
An array of all the translated XML text files for the language.
-
textFileName(optional):
string
The file name that contains the translated version of the XML text files.Example:
translations.xml
Nested Schema : keyBoardLayoutName
Type:
objectThe name of the keyboard layout
Example:
{
"en-US":"US",
"de-DE":"de"
}Nested Schema : name
Type:
objectname of the language
Example:
{
"en-US":"US",
"de-DE":"de"
}Nested Schema : printOptionsExt
Type:
arrayAn object containing the descriptive print options list associated with the language.
Show Source
Nested Schema : textFileConfigurations
Type:
arrayAn array of all the translated XML text files for the language.
Show Source
Nested Schema : Language_PrintOptionsExt
Type:
Show Source
object-
asianCharacters(optional):
boolean
A Boolean flag indicating to print picture based languages, such as Chinese, Japanese, Thai, and Korean, double-wide for easier reading.Example:
false -
isIMETouchscreenHandling(optional):
boolean
A Boolean flag indicating to enable IME Touchscreen handlingExample:
false -
printCustomNumerals(optional):
boolean
A Boolean flag indicating to print custom numerals defined for the language.Example:
false
Nested Schema : Language_textFileConfigurations
Type:
Show Source
object-
baseFileName(optional):
string
The base file name for the translated XML file.Example:
trans_file.xml -
fileType(optional):
integer
The file type of the translated XML file. Select 0 - Custom for any file type not listed.Example:
0 -
languageText(optional):
string
The contents of the translated XML file.Example:
language text
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(optional):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(optional):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(optional):
integer
Error code of the problemExample:
55223 -
status(optional):
integer
HTTP status code.Example:
400 -
title(optional):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(optional):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found