Versions Compared

Old Version 2

changes.mady.by.user Julia Shaptala

Saved on

compared with

New Version 3

changes.mady.by.user Julia Shaptala

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Encrypted

An encrypted customer ID can be obtained upon subscription to the Cloud WebSpellChecker services (paid or trial).

#ParameterPossible ValuesDefault ValueDescription
1format
  • json
  • xml
xmlThe parameter set a response format for output data.
2callback
  • callback function name

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”.
3out_type
  • positions – Return positions and length of misspelled words in a given text and their suggestions.
  • words – Return misspelled words and their suggestions.
wordsThe parameter defines a type of data output whether return misspelled words positions in the provided text or exact words.
4ignore_all_caps
  • 0 – Do not ignore all words written in capital letters (e.g. UPPERCASE). 
  • 1 – Ignore all words written in capital letters.
0The parameter regulates whether to ignore capitalized words or not.
5ignore_words_with_numbers
  • 0 – Do not ignore words that contain numbers (e.g. Number1).
  • 1 – Ignore words that contain numbers.
0The parameter regulates whether to ignore words containing numbers or not.
6ignore_mixed_case
  • 0 – Do not ignore words with mixed case letters (e.g. MixedCase).
  • 1 – Ignore words with mixed case letters.
0The parameter regulates whether to ignore words written with mixed case letters or not.
7ignore_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.
0The parameter regulates whether to ignore domain names, web addresses or not.
8text
  • plain 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.
9slangen_USThe parameter sets a shot code of a language which will be used for check spelling.
10user_dictionary
  • user dictionary name (e.g. testdict)

The parameter specifies a user dictionary name which will be used during check spelling.
11custom_dictionary
  • custom dictionary ID value assigned in a DicId parameter.

This parameter specifies a custom dictionary which will be used for check spelling. 
12user_wordlist
  • additional wordlist

The parameter provides the list of additional coma-separated words which will be used for spellchecking.
13version1.01.0The parameter indicates the version of Web API.
14customerid
  • encrypted_customer_ID value

This parameter specifies a special customer ID value that has to be passed to a request query.

Tip
Warning

Without a valid encrypted customer ID, any request to Cloud WebSpellChecker Web API will fail.


...

Code Block
titleRequest URL (GET): 
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
titleRequest URL (GET): 
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
titleRequest URL (GET): 
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
titleRequest URL (GET): 
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
titleRequest URL (GET): 
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
titleRequest URL (GET): 
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

...