Get Languages
post
/config/sim/v1/setup/getLanguages
Gets all the languages
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Languages
Root Schema : LanguageGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of language objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
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:
integer
This field is used for comparison of strings when strings are to be sorted.Example:
1 -
customerDisplayFont:
string
The font for the customer display.
-
customNumerals:
string
The digit to print in place of the value shown. Leave blank to use the hard-coded values shown.Example:
0123456789 -
keyBoardLayoutName:
object keyBoardLayoutName
The name of the keyboard layout
-
keyboardLayoutObjNum:
integer
The object number of the keyboard layoutExample:
1033 -
languageCulture:
string
The abbreviated language code.Example:
en-US -
localeId:
integer
Locale ID of the language. Refer to Language Codes under Additional Information chapter for more details.Example:
1033 -
localeKey:
string
A unique key that is used to identify the language in the content and configuration API.Example:
en-US -
localeString:
string
The language string.Example:
English (US) -
mappingFont:
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:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the print options associated with the language.Example:
00000000 -
printOptionsExt:
array printOptionsExt
An object containing the descriptive print options list associated with the language.
-
reportFont:
string
The font to use for the language in the Extensible Client local reports.
-
reportFontSize:
integer
The font size to use for the language in the Extensible Client local reports.Example:
23 -
reverseWOrientation:
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:
boolean
A Boolean flag indicating to have the check detail area and customer receipts appear in right-to-left orientation.Example:
false -
textFileConfigurations:
array textFileConfigurations
An array of all the translated XML text files for the language.
-
textFileName:
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:
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:
boolean
A Boolean flag indicating to enable IME Touchscreen handlingExample:
false -
printCustomNumerals:
boolean
A Boolean flag indicating to print custom numerals defined for the language.Example:
false
Nested Schema : Language_textFileConfigurations
Type:
Show Source
object-
baseFileName:
string
The base file name for the translated XML file.Example:
trans_file.xml -
fileType:
integer
The file type of the translated XML file. Select 0 - Custom for any file type not listed.Example:
0 -
languageText:
string
The contents of the translated XML file.Example:
language text