Command name: check
Here is a list of all possible parameters and values that can be used with a new check command.
Parameter | Possible Values | Default Value | Description | |
---|---|---|---|---|
1 | format |
| json | The parameter set a response format for output data. |
2 | callback |
| The parameter 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 | ignore_all_caps |
| 0 | The parameter regulates whether to ignore capitalized words or not. |
4 | ignore_words_with_numbers |
| 0 | The parameter regulates whether to ignore words containing numbers or not. |
5 | ignore_mixed_case |
| 0 | The parameter regulates whether to ignore words written with mixed case letters or not. |
6 | ignore_domain_names |
| 0 | The parameter regulates whether to ignore domain names, web addresses or not. |
7 | tokens | |||
8 | text |
| The parameter defines a text which will be sent for check spelling. The text has to be in the UTF-8 encoding. Any found tags in the text will be interpreted as a plan text as well. Note, that you shouldn't use # and & symbols in the text. | |
9 | lang |
| en_US | The parameter sets a shot code of a language which will be used for check spelling. |
10 | user_dictionary |
| The parameter specifies a user dictionary name which will be used during check spelling. | |
11 | user_wordlist |
| The parameter provides the list of additional coma-separated words which will be used for spellchecking. | |
12 | custom_dictionary |
| The parameter 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 to you account panel on webspellchecker.net website (Login –> Dictionaries –> List of Custom Dictionaries). | |
13 | customerid |
| This parameter specifies a special customer ID value that has to be passed to a request query. An encrypted customer ID can be obtained upon subscription to the Cloud WebSpellChecker services (paid or trial). Without a valid encrypted customer ID, any request to Cloud WebSpellChecker Web API will fail. |
Example 2.1: Check Request using GET (Output in XML)
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=check_spelling&format=xml&text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=en_US&customerid=[encrypted_customer_ID]
Parameters:
- Command: check
- Format: XML
- Text: “This sampl text demonstrates the work of the WebSpellChecker Web API service.”
- Output: words
- Language: American English (en_US)
Request Response:
<?xml version="1.0" encoding="utf-8"?> <check_spelling> <misspelling> <word>sampl</word> <ud>false</ud> <suggestions> <suggestion>sample</suggestion> <suggestion>sampled</suggestion> <suggestion>sampler</suggestion> <suggestion>samples</suggestion> <suggestion>ample</suggestion> <suggestion>amply</suggestion> <suggestion>scamp</suggestion> <suggestion>stamp</suggestion> </suggestions> </misspelling> </check_spelling>
Example 2.2: Check Spelling Request using GET (Output in JSON)
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=check_spelling&format=json&text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=en_US&customerid=[encrypted_customer_ID]
Parameters:
- Command: check_spelling
- Format: JSON
- Text: “This sampl text demonstrates the work of the WebSpellChecker Web API service.”
- Output: words
- Language: American English (en_US)
Request Response:
[ { "word": "sampl", "ud": false, "suggestions": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] } ]
Example 2.3: Check Spelling Request using POST (Output in JSON)
Here we use the same request and parameters as described in example above but form it as a POST request.
https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?
cmd=check_spelling&format=json&text=This sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=en_US&customerid=[encrypted_customer_ID]
Request Response:
[ { "word": "sampl", "ud": false, "suggestions": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] } ]