Documentation Center

Get information about a specific locale

Get information about a locale based on its ID.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The sessionId in the response is your session token. Use this token in all the other calls that you make.

Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v1/locales/<localeId>?token=<sessionId>

Details

  • GET method
  • Content-Type in the header: application/json
  • Mandatory parameters: the session token (as a query string parameter or as a key-value pair in the header) and the ID of the locale (as a URI parameter)

Available filters

You can add the filters as query string parameters or as key-value pairs in the header:
FilterDescription
fields=<fieldName1,fieldName2,…,fieldNameN>The names of the fields to be included in the JSON response, separated by commas. Do not use in conjunction with the excludedFields filter.
excludedFields=<fieldName1,fieldName2,…,fieldNameN>The names of the fields to be excluded from the JSON response, separated by commas. Do not use in conjunction with the fields filter.
Examples:
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales/<localeId>?token=<sessionId>&fields=id,name
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales/<localeId>?token=<sessionId>&excludedFields=name

Advanced filtering

To reduce the amount of data in the result and to improve performance, you can perform the filtering deeper in the project tree structure. For example: <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales/<localeId>?token=<sessionId>&fields=id,name,language(id,locale)

In this case, the returned JSON contains only the fields you specified for each layer:
  • The ID, the name, and the language model of the locale.
  • The ID and the locale of each language.
The same logic applies to the excludedFields filter.

Response

A screen shot that shows a typical response to this call.

Error messages

MessageStatus code
No session token provided or invalid token401 Unauthorized
Resource LOCALE (ID) not found404 Not Found
For input string:\<invalidId>\ (If the ID you entered is not a valid number.)500 Internal Server Error