Breadcrumbs

Page History

...

0 – Do not ignore all words written in capital letters (. UPPERCASE)

1 – Ignore all words written in capital letters.

Parameter

Possible Values

Default Value

Description

format

json
xml

json

The parameter set a response format for output data.

callback

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

ignore_all_caps

tokens

Array of strings, e.g

The parameter regulates whether to ignore capitalized words or not.

ignore_words_with_numbers

0 – Do not ignore words that contain numbers (e.g. Number1).
1 – Ignore words that contain numbers.

The parameter regulates whether to ignore words containing numbers or not.

ignore_mixed_case

0 – Do not ignore words with mixed case letters (e.g. MixedCase).
1 – Ignore words with mixed case letters.

The parameter regulates whether to ignore words written with mixed case letters or not.

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

The parameter regulates whether to ignore domain names, web addresses or not.

["This is a sentence number 1.", "This is a sentence number 2."]

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.

Note
You can use either tokens or text at a time in a request.

tokens

text

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. Note, that you shouldn't use # and & symbols in the text.

lang

Default Languages List (e.g. en_US)
Additional Languages List(e.g. uk_UA)

en_US

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

disable_spelling

true
false

false

The parameter regulates whether to check text for spelling errors.

disable_grammar

true
false

false

The parameter regulates whether to check text for grammar and style problems.

user_dictionary

user dictionary name (e.g. testdict)

The parameter specifies a user dictionary name which will be used during check spelling.

119

user_wordlist

additional wordlist

The parameter provides the list of additional coma-separated words which will be used for spellchecking.

1210

custom_dictionary

custom dictionary IDs (e.g. 100694)

The parameter specifies global custom dictionary IDs which can be used during check spelling.

Info
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.netcom website (Login –> Dictionaries –> List of Custom Dictionaries).

ignore_all_caps

0 – Do not ignore all words written in capital letters (e.g. UPPERCASE).
1 – Ignore all words written in capital letters.

The parameter regulates whether to ignore capitalized words or not.

ignore_words_with_numbers

0 – Do not ignore words that contain numbers (e.g. Number1).
1 – Ignore words that contain numbers.

The parameter regulates whether to ignore words containing numbers or not.

ignore_mixed_case

0 – Do not ignore words with mixed case letters (e.g. MixedCase).
1 – Ignore words with mixed case letters.

The parameter regulates whether to ignore words written with mixed case letters or not.

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

The parameter regulates whether to ignore domain names, web addresses or not.

min_word_length

minimal number of letters in a word to be checked

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.

Note
Applicable only when spelling check is enabled.

custom_punctuation

string of chars (e.g. “-“)

The parameter defines a list of characters that should be considered as delimiters during spelling check.

short_answer

true
false

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

customerid

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.

...

2: Check Request using GET (Output in

...

JSON)

Code Block

title	Request URL (GET):

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

language	xmljs
theme	Emacs

<?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

title	Request URL (GET):

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

language	jsxml
theme	Emacs

[<?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)

...

Content

Space Tools

Versions Compared

Old Version 1

New Version 2

Key

Example 2.

2: Check Request using GET (Output in

JSON)

Example 2.

1: Check

Request using GET (Output in

XML)

Example 2.3: Check Spelling Request using POST (Output in JSON)