Jump to

• Request
• Response

Update Languages

post

/config/sim/v1/setup/updateLanguages

Updates the language. If language is not found is not found, it creates a new language.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef(optional): string(string)
  Detail that Identifies that who made the change
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Language Resource Object

Root Schema : LanguageResourceObject

Type: object

Model 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 layout

  Example: 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

{
    "description":"Model for Language Object",
    "type":"object",
    "required":[
        "objectNum",
        "name"
    ],
    "properties":{
        "objectNum":{
            "description":"Object Number of the language.",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"name of the language",
            "type":"object",
            "example":{
                "en-US":"US",
                "de-DE":"de"
            }
        },
        "reportFont":{
            "type":"string",
            "description":"The font to use for the language in the Extensible Client local reports."
        },
        "reportFontSize":{
            "type":"integer",
            "example":23,
            "description":"The font size to use for the language in the Extensible Client local reports."
        },
        "customerDisplayFont":{
            "description":"The font for the customer display.",
            "type":"string"
        },
        "textFileName":{
            "description":"The file name that contains the translated version of the XML text files.",
            "type":"string",
            "example":"translations.xml"
        },
        "keyboardLayoutObjNum":{
            "description":"The object number of the keyboard layout",
            "type":"integer",
            "example":1033
        },
        "keyBoardLayoutName":{
            "description":"The name of the keyboard layout",
            "type":"object",
            "example":{
                "en-US":"US",
                "de-DE":"de"
            }
        },
        "rightToLeftOrientation":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to have the check detail area and customer receipts appear in right-to-left orientation."
        },
        "reverseWOrientation":{
            "description":"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.",
            "type":"boolean",
            "example":false
        },
        "customNumerals":{
            "description":"The digit to print in place of the value shown. Leave blank to use the hard-coded values shown.",
            "type":"string",
            "example":"0123456789"
        },
        "printOptions":{
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the print options associated with the language.",
            "type":"string",
            "example":"00000000"
        },
        "printOptionsExt":{
            "description":"An object containing the descriptive print options list associated with the language.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Language_PrintOptionsExt"
            }
        },
        "mappingFont":{
            "description":"Use Vmap for Thai and Japanese. Use Amap otherwise.",
            "type":"string",
            "example":"Amap"
        },
        "textFileConfigurations":{
            "description":"An array of all the translated XML text files for the language.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Language_textFileConfigurations"
            }
        },
        "localeString":{
            "description":"The language string.",
            "type":"string",
            "example":"English (US)"
        },
        "localeId":{
            "description":"The Microsoft defined locale ID.",
            "type":"integer",
            "example":"1033"
        },
        "localeKey":{
            "description":"A unique key that is used to identify the language in the content and configuration API.",
            "type":"string",
            "example":"en-US"
        },
        "compareFlag":{
            "description":"This field is used for comparison of strings when strings are to be sorted.",
            "type":"integer",
            "example":1
        },
        "languageCulture":{
            "description":"The abbreviated language code.",
            "type":"string",
            "example":"en-US"
        }
    }
}

Nested Schema : keyBoardLayoutName

Type: object

The name of the keyboard layout

Example:

{
    "en-US":"US",
    "de-DE":"de"
}

Nested Schema : name

Type: object

name of the language

Example:

{
    "en-US":"US",
    "de-DE":"de"
}

Nested Schema : printOptionsExt

Type: array

An object containing the descriptive print options list associated with the language.

Show Source

• Array of: object Language_PrintOptionsExt

{
    "description":"An object containing the descriptive print options list associated with the language.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Language_PrintOptionsExt"
    }
}

Nested Schema : textFileConfigurations

Type: array

An array of all the translated XML text files for the language.

Show Source

• Array of: object Language_textFileConfigurations

{
    "description":"An array of all the translated XML text files for the language.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Language_textFileConfigurations"
    }
}

Nested Schema : Language_PrintOptionsExt

Type: object

Show Source

• 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 handling

  Example: false
• printCustomNumerals(optional): boolean
  A Boolean flag indicating to print custom numerals defined for the language.

  Example: false

{
    "type":"object",
    "properties":{
        "printCustomNumerals":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to print custom numerals defined for the language."
        },
        "isIMETouchscreenHandling":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to enable IME Touchscreen handling"
        },
        "asianCharacters":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to print picture based languages, such as Chinese, Japanese, Thai, and Korean, double-wide for easier reading."
        }
    }
}

Nested Schema : Language_textFileConfigurations

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "fileType":{
            "type":"integer",
            "example":0,
            "description":"The file type of the translated XML file.  Select 0 - Custom for any file type not listed."
        },
        "baseFileName":{
            "type":"string",
            "example":"trans_file.xml",
            "description":"The base file name for the translated XML file."
        },
        "languageText":{
            "type":"string",
            "example":"language text",
            "description":"The contents of the translated XML file."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response object

Body ()

Root Schema : LanguageResponse

Type: object

Show Source

• objectNum(optional): integer
  Object number of the language

  Example: 1

{
    "type":"object",
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the language"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response 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 problem

  Example: 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top