Versions Compared

Old Version 5

changes.mady.by.user user-232a4

Saved on

compared with

New Version 6

changes.mady.by.user user-232a4

Saved on

Key

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

...

#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.

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

Warning

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


Example

...

2.1: Check Spelling Request (XML)

Code Block
titleRequest URL (GET): 
http(s)://svc.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]

...

Code Block
languagexml
themeEmacs
<?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 (JSON)

Code Block
titleRequest URL (GET): 
http(s)://svc.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]

...

Code Block
languagejs
themeEmacs
[{"word":"sampl","ud":"false","suggestions":["sample","sampled","sampler","samples","ample","amply","scamp","stamp"]}]

...

3. Grammar Check Command

Info

Command name: grammar_check

...

#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”.
3text
  • plain text

The parameter defines a text which will be sent for grammar checking. 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.
4slang
  • en_US – American English short code
  • en_GB – British English short  code
en_US

The parameter sets a shot code of a language which will be used for grammar checking. 

Note

The grammar checking feature is available for American English and British English.


Example

...

3.1: Grammar Check Request (XML)

Code Block
titleRequest URL (GET): 
http(s)://svc.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]

...

Code Block
languagexml
themeEmacs
<?xml version="1.0" encoding="utf-8"?>
<grammar_check>
    <grammar_problem>
        <phrase>you builds</phrase>
        <description>Pronoun "you" conflicts with verb "builds."</description>
        <problem_id>437780848</problem_id>
        <suggestions>
            <suggestion>you build</suggestion>
            <suggestion>you, builds</suggestion>
        </suggestions>
    </grammar_problem>
</grammar_check>

Example

...

3.2: Grammar Check Request (JSON)

Code Block
titleRequest URL (GET): 
http(s)://svc.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]

...

Code Block
languagejs
themeEmacs
[{"phrase":"you builds","description":"Pronoun \"you\" conflicts with verb \"builds.\"","problem_id":"437780848",
"suggestions":["you build","you, builds"]}]

...

4. User Dictionary Command

Info

Command name: user_dictionary

...

#Action ParameterParametersPossible ValuesDescription
1createname
  • name of a new user dictionary
The action that creates a new user dictionary.
wordlist
  • coma-separated words which will be added to a new dictionary
2deletename
  • name of a selected user dictionary
The action that deletes a selected user dictionary.
3renamename
  • name of a selected user dictionary
The action that remanes a specified dictionary and sets a new name.
new_name
  • a new name for a chosen user dictionary
4checkname
  • name of a chosen user dictionary
The action that checks if a specified user dictionary exists on the server.
5getdictname
  • name of a required user dictionary
The action requests content of a specified user dictionary. The getdict action is available only for the JSON format.
6addwordname
  • name of a chosen user dictionary
The action adds a new word to a specified user dictionary.

word
  • a new word which will be added to a specified user dictionary
7deletewordname
  • name of a chosen user dictionary
The action removes a word from a specified user dictionary.

word
  • word which will be removed from a specified user dictionary
8editwordname
  • name of a chosen user dictionary
The action replaces a word in a specified user dictionary with a new one.
word
  • word which will be edited
new_word
  • a new word which replaces a word picked for editing

Example

...

4.1: Create User Dictionary (XML)

Code Block
titleRequest URL (GET): 
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=user_dictionary&format=xml&action=create&name=user_dictionary&wordlist=SCAYT,SpellCheckAsYouType,WSC,WebSpellChecker,Proofreader&customerid=[encrypted_customer_ID]

...

Code Block
languagexml
themeEmacs
<?xml version="1.0" encoding="utf-8"?>
<dictionary>
    <name>user_dictionary</name>
    <action>create</action>
</dictionary>

Example

...

4.2: Get User Dictionary Content (JSON)

Code Block
titleRequest URL (GET): 
http(s)://svc.webspellchecker.net/spellcheck3/script/ssrv.fcgi?cmd=user_dictionary&format=json&action=getdict&name=user_dictionary&customerid=[encrypted_customer_ID]

...