The appliance is supported in different languages and help users with their troubles and problems.If you want to use the localized messages, specify locale in you requests. For this, use a special parameter.
|
Parameter Name |
Parameter Description |
|---|---|
|
_LOCALE_ |
The locale for messages in responses from server, you could use it in different formats: languages with territory, for example, en_US, nl_NL, or ru-RU, fr-FR, or just languages, for example, ru, nl, fr. |
For GET request add this parameter as a URL parameter, for POST, PUT and PATCH add this parameter as a JSON parameter in request body. If for some reasons, you couldn't change a request URI or body, you could specify a cookie with the parameter name and value and server will automatically read it and change locale, or you could add the header "Accept-Language" with locale value in your request.
There are the list of supported locales
|
Locale |
Locale Value |
Language |
|---|---|---|
|
|
|
|
|
|
|
|
|
If you could not find your locale in table above, you could use a messages identifier for your custom localization. In responses you could find this parameter with identifier of message.
|
Parameter Name |
Parameter Description |
|---|---|
|
msgid |
The identifier of the message for message customization. |
This parameter could be used for additional messaging too, but do not use this parameter for checking status of an authentication process or other statuses, for this kind of checking API has special parameters.On requests and response in examples below all messages in default English locale, message identifier was removed.