Add Languages
post
/config/sim/v1/setup/languages
Add the language to the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
Language Resource Object
Root Schema : LanguageCUDRequestBody
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 -
keyboardLayoutObjNum:
integer
The object number of the keyboard layoutExample:
1033 -
languageCulture:
string
The abbreviated language code.Example:
en-US -
localeId:
integer
List of values for LocaleId and KeyboardLayoutObjNum. Refer to Language Codes chapter for more detailsExample:
1033 -
mappingFont:
string
Use Vmap for Thai and Japanese. Use Amap otherwise.Example:
Amap -
name(required):
object name
name of the language
-
objectNum(required):
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 -
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 : name
Type:
objectname of the language
Example:
{
"en-US":"US",
"de-DE":"de"
}Nested Schema : textFileConfigurations
Type:
arrayAn array of all the translated XML text files for the language.
Show Source
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
Response
Supported Media Types
- application/json
200 Response
Response object
Root Schema : LanguageResponse
Type:
Show Source
object-
objectNum(required):
integer
Object number of the languageExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
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