Page History
...
Code Block | ||
---|---|---|
| ||
https://your_host_name:443/virtual_directory/api/? |
Here is a list of all possible parameters and values that can be used with the check command.
Note |
---|
The list of parameters can be used and is available only when a spelling check is enabled. These parameters are marked yellow. |
# | Parameter | Possible values | Default value | Description | ||
---|---|---|---|---|---|---|
1 | format |
| json | The parameter sets a response format for output data. | ||
2 | callback |
| The parameter specifies a callback function name that will be used to manipulate the JSON data received from the server. Such an approach enables sharing of data, bypassing same-origin policy. It can be used only along with “format=json”. | |||
3 | text |
| The parameter defines a text which will be sent for check. The text has to be in the UTF-8 encoding. Any found tags in the text will be interpreted as plan text as well. Note, that you shouldn't use # and & symbols in the text. | |||
4 | tokens |
| The parameter defines a text separated into tokens that will be sent for check. The text should be presented as an array of strings. Right now, each string is a token which equals one sentence.
| |||
5 | lang | en_US | The parameter sets a short code of a language which will be used for check. | |||
6 | disable_spelling |
| false | The parameter regulates whether to check text for spelling errors. | ||
7 | disable_grammar |
| false | The parameter regulates whether to check text for grammar and style problems. | ||
8 | user_dictionary |
| The parameter specifies a user dictionary name which will be used during check spelling. | |||
9 | user_wordlist |
| The parameter provides the list of additional comma-separated words which will be used for spell checking. | |||
10 | custom_dictionary |
| The parameter specifies global custom dictionary IDs which can be used during check spelling.
| |||
11 | ignore_all_caps |
| 0 | The parameter regulates whether to ignore capitalized words or not. | ||
12 | ignore_words_with_numbers |
| 0 | The parameter regulates whether to ignore words containing numbers or not. | ||
13 | ignore_mixed_case |
| 0 | The parameter regulates whether to ignore words written with mixed case letters or not. | ||
14 | ignore_domain_names |
| 0 | The parameter regulates whether to ignore domain names, web addresses or not. | ||
15 | min_word_length |
| 3 | The parameter specifies the minimal number of letters in the word which will be checked for spelling. E.g. if 3 is specified, the words with 2 letters and less will be ignored. | ||
16 | custom_punctuation |
| - | The parameter defines a list of characters that should be considered as delimiters during spelling check. | ||
17 | short_answer |
| false | The parameter is responsible for shortening every static string JSON key name, like messages or type, down to its first character, like:
|
Response structure
The result is an array of objects which contains matches, where matches is also an array of objects consisting of attribute-value pairs.
...