WebSpellChecker.net Wiki

Home

Web Service

WebSpellChecker.net web service provides suggestions for spelling corrections for specified text.

Subscribing

To subscribe to the web service please sign-up for our hosted service and get your encrypted customer id

Request url

http://www.webspellchecker.net/spellcheck3/script/ssrv.cgi?run_mode=web_service

Request parameters

ParameterPossible valuesdescription
cmdcheck_spelling, api_versioncheck_spelling - checks spelling, api_version - returns version of current API

For command check_spelling

Parameter Possible valuesdescription
format json, xml Format of response. (default - xml)
callback any JSON callback function. Is actual only for format=json
out_type positions, wordswords - returns misspelled, words and suggestions, positions - returns position in text of misspellings and suggestions (default - words)
ignore_all_caps 0, 1If set to 1 forces to ignore all-caps words (default 0).
ignore_words_with_numbers 0, 1 If set to 1 forces to ignore words with numbers (default 0).
ignore_mixed_case 0, 1 If set to 1 forces to ignore mixed case words(default 0).
ignore_domain_names 0, 1 If set to 1 forces to ignore domain name(default 0).
text any Text to be checked. Only (URL encoded UTF-8) plain text is accepted. If there are any tags found they will be interpreted as a plain text).
slangen_US en_GB pt_BR, da_DK, nl_NL, en_CA, fi_FI, fr_FR, fr_CA, de_DE, el_GR, it_IT, nb_NO, pt_PT, es_ES, sv_SE Language (default - en_US).
user_dictionary any The name of user dictionary to be used in spell checking
custom_dictionary any The name of user dictionary to be used in spell checking
user_wordlist any The coma-separated list of additional dictionary words to be used in spell checking
version 1.0 Version of API to be used.
customerid any encrypted customer id which you will recieve once subscribed in attached ini file

For command user_dictionary

Parameter Possible valuesdescription
format json, xml Format of response. (default - xml)
callback any JSON callback function. Is actual only for format=json
action create, rename, delete, addword, check create, rename, delete - performs appropriate action with user dictionary. addword adds a word to user dictionay, check - checks if user dictionary exists on the server
customerid any encrypted customer id which you will recieve once subscribed in attached ini file
For action create
Parameter Possible valuesdescription
name any The name of user dictionary
wordlist any coma-separated values to be added to created dictionary
For action delete
Parameter Possible valuesdescription
name any The name of user dictionary
For action rename
Parameter Possible valuesdescription
name any The name of user dictionary
new_name any The new name of user dictionary
For action check
Parameter Possible valuesdescription
name any The name of user dictionary
For action addword
Parameter Possible valuesdescription
name any The name of user dictionary
word any The word to be added

For command api_version

No params

Example

Request

http://www.webspellchecker.net/spellcheck3/script/ssrv.cgi?customerid=1:wiN6M-YQYOz2-PTPoa2-3yaA92-PmWom-3CEx53-jHqwR3-NYK6b-XR5Uh1-M7YAp4&cmd=check_spelling&version=1.0&out_type=words&slang=en_US&callback=cc&format=xml&text=texttt+box+asdfasdf0+asdf.asdf+ADASDF+ASDFasdf&ignore_all_caps=1&ignore_mixed_case=1&ignore_domain_names=1&ignore_words_with_numbers=1

Response

<?xml version="1.0" encoding="utf-8"?>
<spellcheck>
<misspelling>
<word>texttt</word>
<suggestions>
<suggestion>text</suggestion>
<suggestion>texts</suggestion>
<suggestion>Tex</suggestion>
<suggestion>extent</suggestion>
<suggestion>exit</suggestion>
<suggestion>extant</suggestion>
<suggestion>extort</suggestion>
<suggestion>sextet</suggestion>
<suggestion>stet</suggestion>
<suggestion>extents</suggestion>
<suggestion>stetted</suggestion>
<suggestion>test</suggestion>
<suggestion>extorts</suggestion>
<suggestion>tatty</suggestion>
<suggestion>testate</suggestion>
</suggestions>
</misspelling>
</spellcheck>