API Reference / API Methods / Dictionaries / Get dictionary settings

Get Dictionary Settings

A
Required API Key: any key with the settings ACL
Method signature 
$client->getDictionarySettings();
See code examples

About this method # A

Retrieve the dictionary override settings for plurals, stop words, and compound words.

You can find the list of ‘languages` settings in the settings parameters page.

Examples # A

Get stopword settings#

Copy 
1

$client->getDictionarySettings();

Parameters # A

requestOptions #
type: key-value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the request.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

Copy 
1
2
3
4
5
6
7

{
  "disableStandardEntries": {
    "stopwords": {
      "ru": "true"
    }
  }
}
settings #
object

Map of language ISO code supported by the dictionary (for example, “de” for German) to a boolean value.

When set to true, the standard entries for the language are disabled.

Fetch settings doesn’t return false values.

"disableStandardEntries": {
  "stopwords": {
    "ru": "true",
    "en": "true",
    // ...
  }
}
Did you find this page helpful?
PHP v3