_include_check_command_server_cloud_55x

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 xml	json	Sets a response format for output data.
2	callback	callback function name		Specifies 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	plain text		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. Avoid using # and & symbols in the text.
4	tokens	Array of strings, e.g. ["This is a sentence number 1.", "This is a sentence number 2."]		Defines a 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	Default Languages List (e.g. en_US) Additional Languages List (e.g. ar_SA)	en_US	Sets a short code of a language which will be used for check.
6	disable_spelling	true false	false	Regulates whether to check text for spelling errors.
7	disable_grammar	true false	false	Regulates whether to check text for grammar and style problems.
8	user_dictionary	user dictionary name (e.g. testdict)		Specifies a user dictionary name which will be used during check spelling.
9	user_wordlist	additional wordlist		Provides the list of additional comma-separated words which will be used for spell checking.
10	custom_dictionary	custom dictionary IDs (e.g. 100694)		Specifies global custom dictionary IDs which can be used during check spelling. Each new Dictionary on the creation obtains its unique Dictionary ID. You can find information about your custom dictionaries by logging in to your account panel onwebspellchecker.com website (Login –> Dictionaries –> List of Custom Dictionaries).
11	ignore_all_caps	0 – Do not ignore all words written in capital letters (e.g. UPPERCASE). 1 – Ignore all words written in capital letters.	0	Regulates whether to ignore capitalized words or not.
12	ignore_words_with_numbers	0 – Do not ignore words that contain numbers (e.g. Number1). 1 – Ignore words that contain numbers.	0	Regulates whether to ignore words containing numbers or not.
13	ignore_mixed_case	0 – Do not ignore words with mixed case letters (e.g. MixedCase). 1 – Ignore words with mixed case letters.	0	Regulates whether to ignore words written with mixed case letters or not.
14	ignore_domain_names	0 – Do not ignore web addresses that start with either “www”, “http:” or “https:” and end with a domain name. 1 – Ignore web addresses and domain names.	0	Regulates whether to ignore domain names, web addresses or not.
15	min_word_length	minimal number of letters in a word to be checked	3	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	string of chars (e.g. “-“)	-	Defines a list of characters that should be considered as delimiters during spelling check.
17	short_answer	true false	false	Enables shortening every static string JSON key name, like messages or type down to its first character, for example: m - matches, message o - offset l - length t - type r - rule s - suggestions
18	customerid	encrypted_customer_ID value		Specifies a special customer ID value that has to be passed to a request query. A customer ID can be obtained upon subscription to the Cloud services (paid or trial). Be sure to use a valid customer ID. Otherwise any request to Web API Cloud will fail.

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	spelling grammar	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		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	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 inon UI.
suggestions	array of strings		Suggested corrections for spelling, grammar or style problem.
rule	string		Short description of the problem by rule; available only for type 'grammar'.
message	string		Description of the problem; available only for type 'grammar'.

Type: Spelling

{
    "result": [
        {
            "matches": [
                {
                    "type": "spelling",
                    "offset": X1,
                    "length": Y1,
					"ud": true,
                    "suggestions": ["..."]
                }
            ]
        }
    ]
}

Type: Grammar

{
    "result": [
        {
            "matches": [
                {
                    "type": "grammar",
                    "offset": X2,
                    "length": Y2,
                    "rule": "...",
                    "message": "...",
                    "suggestions": ["..."]
                }
            ]
        }
    ]
}

Content

Space Tools

Response Structure