Page History
...
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 – Do not ignore all words written in capital letters (tokens |
| . UPPERCASE)
| 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. | |||
| The parameter 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.
| ||||||
4 | 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. | |
95 | lang |
| en_US | The parameter sets a shot 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 | .10 | user_dictionary |
| The parameter specifies a user dictionary name which will be used during check spelling. | |||
119 | user_wordlist |
| The parameter provides the list of additional coma-separated words which will be used for spellchecking. | ||||
1210 | 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 'm' or 't'. | |||
18 | 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).
|
Example 2.
...
2: Check Request using GET (Output in
...
JSON)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=check_spelling&format=xmljson&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: XMLjson
- Text: “This “this sampl text demonstrates the work of the WebSpellChecker Web API service.”Output: words
- Language: American English (en_US)
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> <check_spelling>[ <misspelling>{ <word>sampl</word> "word": "sampl", <ud>false</ud>"ud": false, <suggestions>"suggestions": [ <suggestion>sample</suggestion>"sample", <suggestion>sampled</suggestion>"sampled", <suggestion>sampler</suggestion>"sampler", <suggestion>samples</suggestion>"samples", <suggestion>ample</suggestion>"ample", <suggestion>amply</suggestion>"amply", <suggestion>scamp</suggestion>"scamp", <suggestion>stamp</suggestion>"stamp" </suggestions>] </misspelling> </check_spelling>} ] |
Example 2.
...
1: Check
...
Request using GET (Output in
...
XML)
Code Block | ||
---|---|---|
| ||
http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=check_spelling&format=jsonxml&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: JSONXML
- Text: “This sampl text demonstrates the work of the WebSpellChecker Web API service.”
- Output: words
- Language: American English (en_US)
Request Response:
Code Block | ||||
---|---|---|---|---|
| ||||
[<?xml version="1.0" encoding="utf-8"?> <check_spelling> {<misspelling> "word": "sampl",<word>sampl</word> "ud": false,<ud>false</ud> "suggestions": [<suggestions> "sample",<suggestion>sample</suggestion> "sampled",<suggestion>sampled</suggestion> "sampler",<suggestion>sampler</suggestion> "samples",<suggestion>samples</suggestion> "ample",<suggestion>ample</suggestion> "amply",<suggestion>amply</suggestion> "scamp",<suggestion>scamp</suggestion> "stamp"<suggestion>stamp</suggestion> ]</suggestions> } ]</misspelling> </check_spelling> |
Example 2.3: Check Spelling Request using POST (Output in JSON)
...