Page History
...
# | Parameter | Possible Values | Default Value | Description | |||
---|---|---|---|---|---|---|---|
1 | format |
| xml | 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 | out_type |
| words | The parameter defines a type of data output whether return misspelled words positions in the provided text or exact words. | |||
4 | ignore_all_caps |
| 0 | The parameter regulates whether to ignore capitalized words or not. | |||
5 | ignore_words_with_numbers |
| 0 | The parameter regulates whether to ignore words containing numbers or not. | |||
6 | ignore_mixed_case |
| 0 | The parameter regulates whether to ignore words written with mixed case letters or not. | |||
7 | ignore_domain_names |
| 0 | The parameter regulates whether to ignore domain names, web addresses or not. | |||
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. | ||||
9 | slang |
| 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 | custom_dictionary |
| This parameter specifies a custom dictionary which will be used for check spelling. | ||||
12 | user_wordlist |
| The parameter provides the list of additional coma-separated words which will be used for spellchecking. | ||||
13 | version | 1.0 | 1.0 | The parameter indicates the version of Web API. | |||
14 | customerid |
| This parameter specifies a special customer ID value that has to be passed to a request query. Tip | An encrypted customer ID can be obtained upon subscription to the Cloud WebSpellChecker services (paid or trial).
|
...
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellchecksvc.webspellchecker.net/spellcheck3/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_spelling
- Format: XML
- Text: “This sampl text demonstrates the work of the WebSpellChecker Web API service.”
- Output: words
- Language: American English (en_US)
...
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellchecksvc.webspellchecker.net/spellcheck3/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)
...
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellchecksvc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=grammar_check&format=xml&text=Web API provides a gramar checking command that will help you builds a custom solution.&slang=en_US&customerid=[encrypted_customer_ID] |
Parameters:
- Command: grammar_check
- Format: XML
- Text: “Web API provides a gramar checking command that will help you builds a custom solution.”
- Language: American English (en_US)
...
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellchecksvc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=grammar_check&format=json&text=Web API provides a gramar checking command that will help you builds a custom solution.&slang=en_US&customerid=[encrypted_customer_ID] |
Parameters:
- Command: grammar_check
- Format: JSON
- Text: “Web API provides a gramar checking command that will help you builds a custom solution.”
- Language: American English (en_US)
...
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellchecksvc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=user_dictionary&format=xml&action=create&name=user_dictionary&wordlist=SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, ProofreaderProofreader&customerid=[encrypted_customer_ID] |
Parameters:
- Command: user_dictionary
- Action: Create
- Name: “user_dictionary”
- Wordlist: “SCAYT, SpellCheckAsYouType, WSC, WebSpellChecker, Proofreader”
- Format: XML
...
Code Block | ||
---|---|---|
| ||
http(s)://your_host_name/spellchecksvc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[encrypted_customer_ID] |
Parameters:
- Command: user_dictionary
- Action: getdict
- Name: “user_dictionary”
- Format: JSON
...