The check command is available since the release of WebSpellChecker 5.5.4x in October 2019. It combines all available check types (spelling and grammar) of text in a single command.
Command name: check
Here is a list of all possible parameters and values that can be used with the check command.
The list of parameters can be used and available only when spelling check is enabled. These parameters are marked with yellow color.
# | Parameter | Possible Values | Default Value | Description |
---|---|---|---|---|
1 | format |
| json | The response format for output data. |
2 | callback |
| A callback function name that will be used to manipulate with the JSON data received from the server. Such approach enables sharing of data bypassing same-origin policy. It can be used only along with “format=json”. | |
3 | text |
| A piece of 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. Avoid using # and & symbols in the text. | |
4 | tokens |
| A piece of text separated in 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. You can use either tokens or text at a time in a request. However, using text is more common. | |
5 | lang |
| en_US | A short code of a language which will be used for check. |
6 | disable_spelling |
| false | Check text for spelling errors or not. |
7 | disable_grammar |
| false | Check text for grammar and style problems or not. |
8 | user_dictionary |
| A user dictionary name which will be used during check spelling. | |
9 | user_wordlist |
| The list of additional comma-separated words which will be used for spell checking. | |
10 | custom_dictionary |
| ||
11 | ignore_all_caps |
| 0 | Ignore capitalized words or not. |
12 | ignore_words_with_numbers |
| 0 | Ignore words containing numbers or not. |
13 | ignore_mixed_case |
| 0 | Ignore words written with mixed case letters or not. |
14 | ignore_domain_names |
| 0 | Ignore domain names, web addresses or not. |
15 | min_word_length |
| 3 | 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 |
| - | A list of characters that should be considered as delimiters during spelling check. |
17 | short_answer |
| false | Enables shortening every static string JSON key name, like messages or type down to its first character, for example:
|
18 | customerid |
| A special customer ID value (activation key) that has to be passed to a request query. It's obtained upon subscription to the Cloud services (paid or trial). Applicable only for the Cloud version. |
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.
The table below represents the following attribute-value pairs:
Attribute | Type | Value | Description |
---|---|---|---|
type | string |
| Type of the problem found. |
offset | number | Start position of a problem found in a sentence/text; start position value here equals '0'’. | |
length | number | The length of offset from the beginning of the error; offset here is the beginning of error related to sentence/text plus the length of the error. | |
ud | boolean |
| True if a misspelled word is present in a user dictionary. This attribute-value pair is used to indicate the application not to underline the word in UI. |
suggestions | array of strings | Suggested corrections for spelling, grammar or style problem. | |
rule | string | A short description of the problem by rule; available only for type 'grammar'. | |
message | string | Description of the problem; available only for type 'grammar'. |
{ "result": [ { "matches": [ { "type": "spelling", "offset": X1, "length": Y1, "ud": true, "suggestions": ["..."] } ] } ] }
{ "result": [ { "matches": [ { "type": "grammar", "offset": X2, "length": Y2, "rule": "...", "message": "...", "suggestions": ["..."] } ] } ] }