Documentation Center

Get locales

Get a list of the locales defined on your system.

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?token=<sessionId>

Details

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

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.
offset=<number>The zero-based starting index in the entire collection of the first item to return.
limit=<number>The maximum number of collection items to return for a single request. By default, 30. The limit should be greater than or equal to 1.
clientId=<number>The ID of the client whose locales you want to get. If you do not specify it, all the locales are retrieved.
Examples:
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales?token=<sessionId>&fields=id,name
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales?token=<sessionId>&excludedFields=name
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales?token=<sessionId>&offset=10&limit=7
  • <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales?token=<sessionId>&clientId=1033

Advanced filtering

To reduce the amount of data in the result and to improve performance, you can perform the filtering deeper in the result tree structure. For example: <protocol>://<ws-host>:<ws-port>/ws-api/v1/locales?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
Limit not provided or invalid (If the limit is not greater than or equal to 1.)400 Bad Request
Offset not provided or invalid (If the offset is not greater than or equal to 1.)400 Bad Request
Optional filter clientId is invalid (If the ID of the client is not a valid number.)400 Bad Request
Offset out of range. Collection has only n items (If the offset value is greater than n.)400 Bad Request
No session token provided or invalid token401 Unauthorized
Resource CLIENT (ID) not found404 Not Found

Troubleshooting

  • Make sure that the endpoint you are calling is correct.
  • Make sure that you are using the GET method for the call.
  • Make sure that the Content-Type in the header is application/json.
  • Make sure that your session token is correct and that it has not expired.