Documentation Center

Get linguistic filters

Get a list of the linguistic filters 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/v2/linguisticFilters?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.
filterType=<integer>The type of filters to retrieve.
Examples:
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/linguisticFilters?token=<sessionId>&fields=id,name,groups(id,name)
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/linguisticFilters?token=<sessionId>&filterType=5

Response

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

Error messages

MessageStatus code
Limit not provided or invalid (Its value should be greater than or equal to 1.)400 Bad Request
Offset not provided or invalid (If the value is negative.)400 Bad Request
Required filter filterType not provided or invalid 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