Jump to

• Request
• Response

Get Languages

post

/config/sim/v1/setup/getLanguages

Gets all the languages

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

Language Get Request Body

Root Schema : LanguageGetRequestBody

Type: object

Show Source

• include: string
  Example: locations
• 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 translated strings returned.

  Example: en-US, de-DE, es-MX
• limit: integer
  Number of results returned in this page. Not required if paging parameters are not supported.

  Example: 10
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported

  Example: 2
• orderBy: string
  Sorts the response by the specified field name and sort order.

  Example: items.objectNum:asc
• searchCriteria: string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"items.objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, de-DE, es-MX",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Language objects of the organization

Body ()

Root Schema : LanguageGetResponse

Type: object

Show Source

• count(required): integer
  Current response recount count.

  Example: 9
• hasMore(required): boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items(required): array items
  Array of language objects of the organization.
• limit(required): integer
  Server page size

  Example: 10
• offset(required): integer
  Starting resource record index

  Example: 0
• totalResults(required): integer
  Total number of rows (excluding the paging parameters)

  Example: 100

{
    "type":"object",
    "required":[
        "totalResults",
        "hasMore",
        "count",
        "items",
        "offset",
        "limit"
    ],
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response recount count."
        },
        "items":{
            "type":"array",
            "description":"Array of language objects of the organization.",
            "items":{
                "$ref":"#/definitions/LanguageResourceObject"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of language objects of the organization.

Show Source

• Array of: object LanguageResourceObject
  Model for Language Object

{
    "type":"array",
    "description":"Array of language objects of the organization.",
    "items":{
        "$ref":"#/definitions/LanguageResourceObject"
    }
}

Nested Schema : LanguageResourceObject

Type: object

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

  Example: 1033
• languageCulture: string
  The abbreviated language code.

  Example: en-US
• localeId: integer
  List of values for LocaleId and KeyboardLayoutObjNum. Format - "localeId, localeKey, localeString" | localeID | localeKey | localeString | |-----------|-----------|-------------------------------| |1025| ar-SA| Arabic - Saudi Arabia| |1026| bg-BG| Bulgarian| |1027| ca-ES| Catalan| |1028| zh-TW| Chinese - Taiwan| |1029| cs-CZ| Czech| |1030| da-DK| Danish| |1031| de-DE| German - Germany| |1032| el-GR| Greek| |1033| en-US| English - United States| |1034| es-ES| Spanish - Spain (Traditional Sort)| |1035| fi-FI| Finnish| |1036| fr-FR| French - France| |1037| he-IL| Hebrew| |1038| hu-HU| Hungarian| |1039| is-IS| Icelandic| |1040| it-IT| Italian - Italy| |1041| ja-JP| Japanese| |1042| ko-KR| Korean| |1043| nl-NL| Dutch - Netherlands| |1044| nb-NO| Norwegian (Bokm??l)| |1045| pl-PL| Polish| |1046| pt-BR| Portuguese - Brazil| |1048| ro-RO| Romanian| |1049| ru-RU| Russian| |1050| hr-HR| Croatian| |1051| sk-SK| Slovak| |1052| sq-AL| Albanian - Albania| |1053| sv-SE| Swedish| |1054| th-TH| Thai| |1055| tr-TR| Turkish| |1056| ur-PK| Urdu - Pakistan| |1057| id-ID| Indonesian| |1058| uk-UA| Ukrainian| |1059| be-BY| Belarusian| |1060| sl-SI| Slovenian| |1061| et-EE| Estonian| |1062| lv-LV| Latvian| |1063| lt-LT| Lithuanian| |1065| fa-IR| Persian| |1066| vi-VN| Vietnamese| |1067| hy-AM| Armenian - Armenia| |1068| az-Latn-AZ| Azeri (Latin)| |1069| eu-ES| Basque| |1071| mk-MK| F.Y.R.O. Macedonian| |1078| af-ZA| Afrikaans - South Africa| |1079| ka-GE| Georgian| |1080| fo-FO| Faroese| |1081| hi-IN| Hindi| |1086| ms-MY| Malay - Malaysia| |1087| kk-KZ| Kazakh| |1088| ky-KG| Kyrgyz (Cyrillic)| |1089| sw-KE| Swahili| |1091| uz-Latn-UZ| Uzbek (Latin)| |1092| tt-RU| Tatar| |1094| pa-IN| Punjabi| |1095| gu-IN| Gujarati| |1097| ta-IN| Tamil| |1098| te-IN| Telugu| |1099| kn-IN| Kannada| |1102| mr-IN| Marathi| |1103| sa-IN| Sanskrit| |1104| mn-MN| Mongolian (Cyrillic)| |1110| gl-ES| Galician| |1111| kok-IN| Konkani| |1114| syr-SY| Syriac| |1125| dv-MV| Divehi| |2049| ar-IQ| Arabic - Iraq| |2052| zh-CN| Chinese - People's Republic of China| |2055| de-CH| German - Switzerland| |2057| en-GB| English - United Kingdom| |2058| es-MX| Spanish - Mexico| |2060| fr-BE| French - Belgium| |2064| it-CH| Italian - Switzerland| |2067| nl-BE| Dutch - Belgium| |2068| nn-NO| Norwegian (Nynorsk)| |2070| pt-PT| Portuguese - Portugal| |2074| sr-Latn-CS| Serbian (Latin)| |2077| sv-FI| Swedish - Finland| |2092| az-Cyrl-AZ| Azeri (Cyrillic)| |2110| ms-BN| Malay - Brunei Darussalam| |2115| uz-Cyrl-UZ| Uzbek (Cyrillic)| |3073| ar-EG| Arabic - Egypt| |3076| zh-HK| Chinese - Hong Kong SAR| |3079| de-AT| German - Austria| |3081| en-AU| English - Australia| |3082| es-ES| Spanish - Spain (Modern Sort)| |3084| fr-CA| French - Canada| |3098| sr-Cyrl-CS| Serbian (Cyrillic)| |4097| ar-LY| Arabic - Libya| |4100| zh-SG| Chinese - Singapore| |4103| de-LU| German - Luxembourg| |4105| en-CA| English - Canada| |4106| es-GT| Spanish - Guatemala| |4108| fr-CH| French - Switzerland| |5121| ar-DZ| Arabic - Algeria| |5124| zh-MO| Chinese - Macao SAR| |5127| de-LI| German - Liechtenstein| |5129| en-NZ| English - New Zealand| |5130| es-CR| Spanish - Costa Rica| |5132| fr-LU| French - Luxembourg| |6145| ar-MA| Arabic - Morocco| |6153| en-IE| English - Ireland| |6154| es-PA| Spanish - Panama| |6156| fr-MC| French - Monaco| |7169| ar-TN| Arabic - Tunisia| |7177| en-ZA| English - South Africa| |7178| es-DO| Spanish - Dominican Republic| |8193| ar-OM| Arabic - Oman| |8201| en-JM| English - Jamaica| |8202| es-VE| Spanish - Venezuela| |9217| ar-YE| Arabic - Yemen| |9225| en-029| English - Caribbean| |9226| es-CO| Spanish - Colombia| |10241| ar-SY| Arabic - Syria| |10249| en-BZ| English - Belize| |10250| es-PE| Spanish - Peru| |11265| ar-JO| Arabic - Jordan| |11273| en-TT| English - Trinidad| |11274| es-AR| Spanish - Argentina| |12289| ar-LB| Arabic - Lebanon| |12297| en-ZW| English - Zimbabwe| |12298| es-EC| Spanish - Ecuador| |13313| ar-KW| Arabic - Kuwait| |13321| en-PH| English - Philippines| |13322| es-CL| Spanish - Chile| |14337| ar-AE| Arabic - U.A.E.| |14346| es-UY| Spanish - Uruguay| |15361| ar-BH| Arabic - Bahrain| |15370| es-PY| Spanish - Paraguay| |16385| ar-QA| Arabic - Qatar| |16394| es-BO| Spanish - Bolivia| |17418| es-SV| Spanish - El Salvador| |18442| es-HN| Spanish - Honduras| |19466| es-NI| Spanish - Nicaragua| |20490| es-PR| Spanish - Puerto Rico|

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

{
    "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 0s & 1s of length 8 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":"List of values for LocaleId and KeyboardLayoutObjNum. Format - \"localeId, localeKey, localeString\"\n| localeID  | localeKey | localeString                  |\n|-----------|-----------|-------------------------------|\n|1025| ar-SA| Arabic - Saudi Arabia|\n|1026| bg-BG| Bulgarian|\n|1027| ca-ES| Catalan|\n|1028| zh-TW| Chinese - Taiwan|\n|1029| cs-CZ| Czech|\n|1030| da-DK| Danish|\n|1031| de-DE| German - Germany|\n|1032| el-GR| Greek|\n|1033| en-US| English - United States|\n|1034| es-ES| Spanish - Spain (Traditional Sort)|\n|1035| fi-FI| Finnish|\n|1036| fr-FR| French - France|\n|1037| he-IL| Hebrew|\n|1038| hu-HU| Hungarian|\n|1039| is-IS| Icelandic|\n|1040| it-IT| Italian - Italy|\n|1041| ja-JP| Japanese|\n|1042| ko-KR| Korean|\n|1043| nl-NL| Dutch - Netherlands|\n|1044| nb-NO| Norwegian (Bokm??l)|\n|1045| pl-PL| Polish|\n|1046| pt-BR| Portuguese - Brazil|\n|1048| ro-RO| Romanian|\n|1049| ru-RU| Russian|\n|1050| hr-HR| Croatian|\n|1051| sk-SK| Slovak|\n|1052| sq-AL| Albanian - Albania|\n|1053| sv-SE| Swedish|\n|1054| th-TH| Thai|\n|1055| tr-TR| Turkish|\n|1056| ur-PK| Urdu - Pakistan|\n|1057| id-ID| Indonesian|\n|1058| uk-UA| Ukrainian|\n|1059| be-BY| Belarusian|\n|1060| sl-SI| Slovenian|\n|1061| et-EE| Estonian|\n|1062| lv-LV| Latvian|\n|1063| lt-LT| Lithuanian|\n|1065| fa-IR| Persian|\n|1066| vi-VN| Vietnamese|\n|1067| hy-AM| Armenian - Armenia|\n|1068| az-Latn-AZ| Azeri (Latin)|\n|1069| eu-ES| Basque|\n|1071| mk-MK| F.Y.R.O. Macedonian|\n|1078| af-ZA| Afrikaans - South Africa|\n|1079| ka-GE| Georgian|\n|1080| fo-FO| Faroese|\n|1081| hi-IN| Hindi|\n|1086| ms-MY| Malay - Malaysia|\n|1087| kk-KZ| Kazakh|\n|1088| ky-KG| Kyrgyz (Cyrillic)|\n|1089| sw-KE| Swahili|\n|1091| uz-Latn-UZ| Uzbek (Latin)|\n|1092| tt-RU| Tatar|\n|1094| pa-IN| Punjabi|\n|1095| gu-IN| Gujarati|\n|1097| ta-IN| Tamil|\n|1098| te-IN| Telugu|\n|1099| kn-IN| Kannada|\n|1102| mr-IN| Marathi|\n|1103| sa-IN| Sanskrit|\n|1104| mn-MN| Mongolian (Cyrillic)|\n|1110| gl-ES| Galician|\n|1111| kok-IN| Konkani|\n|1114| syr-SY| Syriac|\n|1125| dv-MV| Divehi|\n|2049| ar-IQ| Arabic - Iraq|\n|2052| zh-CN| Chinese - People's Republic of China|\n|2055| de-CH| German - Switzerland|\n|2057| en-GB| English - United Kingdom|\n|2058| es-MX| Spanish - Mexico|\n|2060| fr-BE| French - Belgium|\n|2064| it-CH| Italian - Switzerland|\n|2067| nl-BE| Dutch - Belgium|\n|2068| nn-NO| Norwegian (Nynorsk)|\n|2070| pt-PT| Portuguese - Portugal|\n|2074| sr-Latn-CS| Serbian (Latin)|\n|2077| sv-FI| Swedish - Finland|\n|2092| az-Cyrl-AZ| Azeri (Cyrillic)|\n|2110| ms-BN| Malay - Brunei Darussalam|\n|2115| uz-Cyrl-UZ| Uzbek (Cyrillic)|\n|3073| ar-EG| Arabic - Egypt|\n|3076| zh-HK| Chinese - Hong Kong SAR|\n|3079| de-AT| German - Austria|\n|3081| en-AU| English - Australia|\n|3082| es-ES| Spanish - Spain (Modern Sort)|\n|3084| fr-CA| French - Canada|\n|3098| sr-Cyrl-CS| Serbian (Cyrillic)|\n|4097| ar-LY| Arabic - Libya|\n|4100| zh-SG| Chinese - Singapore|\n|4103| de-LU| German - Luxembourg|\n|4105| en-CA| English - Canada|\n|4106| es-GT| Spanish - Guatemala|\n|4108| fr-CH| French - Switzerland|\n|5121| ar-DZ| Arabic - Algeria|\n|5124| zh-MO| Chinese - Macao SAR|\n|5127| de-LI| German - Liechtenstein|\n|5129| en-NZ| English - New Zealand|\n|5130| es-CR| Spanish - Costa Rica|\n|5132| fr-LU| French - Luxembourg|\n|6145| ar-MA| Arabic - Morocco|\n|6153| en-IE| English - Ireland|\n|6154| es-PA| Spanish - Panama|\n|6156| fr-MC| French - Monaco|\n|7169| ar-TN| Arabic - Tunisia|\n|7177| en-ZA| English - South Africa|\n|7178| es-DO| Spanish - Dominican Republic|\n|8193| ar-OM| Arabic - Oman|\n|8201| en-JM| English - Jamaica|\n|8202| es-VE| Spanish - Venezuela|\n|9217| ar-YE| Arabic - Yemen|\n|9225| en-029| English - Caribbean|\n|9226| es-CO| Spanish - Colombia|\n|10241| ar-SY| Arabic - Syria|\n|10249| en-BZ| English - Belize|\n|10250| es-PE| Spanish - Peru|\n|11265| ar-JO| Arabic - Jordan|\n|11273| en-TT| English - Trinidad|\n|11274| es-AR| Spanish - Argentina|\n|12289| ar-LB| Arabic - Lebanon|\n|12297| en-ZW| English - Zimbabwe|\n|12298| es-EC| Spanish - Ecuador|\n|13313| ar-KW| Arabic - Kuwait|\n|13321| en-PH| English - Philippines|\n|13322| es-CL| Spanish - Chile|\n|14337| ar-AE| Arabic - U.A.E.|\n|14346| es-UY| Spanish - Uruguay|\n|15361| ar-BH| Arabic - Bahrain|\n|15370| es-PY| Spanish - Paraguay|\n|16385| ar-QA| Arabic - Qatar|\n|16394| es-BO| Spanish - Bolivia|\n|17418| es-SV| Spanish - El Salvador|\n|18442| es-HN| Spanish - Honduras|\n|19466| es-NI| Spanish - Nicaragua|\n|20490| es-PR| Spanish - Puerto Rico|\n",
            "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: 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 handling

  Example: false
• printCustomNumerals: 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: 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

{
    "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."
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

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

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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top