Breadcrumbs

Page History

Excerpt Include

	IN:_include_check_command_server_cloud_55x
	IN:_include_check_command_server_cloud_55x
nopanel	true

Example 1.1 [GET]: Check request for American English text with

...

all available check types (

...

Info
Command name: check

Here is a list of all possible parameters and values that can be used with the check command.

Note
The list of parameters can be used and available only when spelling check is enabled. These parameters are marked with yellow color.

...

json
xml

...

callback function name

...

plain text

...

Array of strings, e.g. ["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. However, using text is more common.

output in JSON)

Code Block

title	Request URL (GET):

http(s)://svc.webspellchecker.net/api?cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=json&customerid=[your-service-id]

Parameters:

Command: check
Text: this sampl text demonstrates the work of the Web API service.
Language: en_US
Format: json

Request response:

Code Block

language	js
theme	Emacs

{
    "result": [
        {
            "matches": [
                {
                    "type": "spelling",
                    "offset": 5,
                    "length": 5,
                    "suggestions": [
                        "sample",
                        "sampled",
                        "sampler",
                        "samples",
                        "ample",
                        "amply",
                        "scamp",
                        "stamp"
                    ]
                },
                {
                    "type": "grammar",
                    "offset": 0,
                    "length": 4,
                    "rule": "UPPERCASE_SENTENCE_START",
                    "message": "This sentence does not start with an uppercase letter",
                    "suggestions": [
                        "This"
                    ]
                }
            ]
        }
    ]
}

Example 1.2 [GET]: Check request for American English text with all available check types (output in XML)

Code Block

title	Request URL (GET):

http(s)://svc.webspellchecker.net/api?cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=xml&customerid=[your-service-id]

Parameters:

Command: check
Text: this sampl text demonstrates the work of the Web API service.
Language: en_US
Format: xml

Request response:

Code Block

language	xml
theme	Emacs

<result>
	<result>
		<matches>
			<matches>
				<type>spelling</type>
				<offset>5</offset>
				<length>5</length>
				<suggestions>
					<suggestions>sample</suggestions>
					<suggestions>sampled</suggestions>
					<suggestions>sampler</suggestions>
					<suggestions>samples</suggestions>
					<suggestions>ample</suggestions>
					<suggestions>amply</suggestions>
					<suggestions>scamp</suggestions>
					<suggestions>stamp</suggestions>
				</suggestions>
			</matches>
			<type>grammar</type>
			<offset>0</offset>
			<length>4</length>
			<rule>UPPERCASE_SENTENCE_START</rule>
			<message>This sentence does not start with an uppercase letter</message>
			<suggestions>
				<suggestions>This</suggestions>
			</suggestions>
		</matches>
	</result>
</result>

Example 1.3 [GET]: Check request for American English text as two tokens with all available check types (output in JSON)

Code Block

title	Request URL (GET):

https://svc.webspellchecker.net/api?cmd=check&tokens=["this sampl text.", " It demonstrate the work of the Web API service."]&lang=en_US&customerid=[your-service-id]

Parameters:

Command: check
Tokens: ["this sampl text.", " It demonstrate the work of the Web API service."]
Language: en_US
Format: json

Request response:

Code Block

language	js
theme	Emacs

{
    "result":

...

true
false

...

true
false

...

user dictionary name (e.g. testdict)

...

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

...

additional wordlist

...

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

...

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 logging in to your account panel on webspellchecker.com website (Login –> Dictionaries –> List of Custom Dictionaries).

...

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.

...

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.

...

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.

...

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.

...

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.

...

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

...

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

...

true
false

...

The parameter is responsible for shortening every static string JSON key name, like messages or type, down to its first character, like:

m - matches, message
o - offset
l - length
t - type
r - rule
s - suggestions

...

encrypted_customer_ID value

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

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

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

Response Structure

The result is an array of objects whict contains matches, where matches is also an array of objects consisting of attribute-value pairs.

The following attribute-value pairs

...

spelling
grammar

...

true

...

Code Block

language	js
theme	Emacs
title	Type: Spelling

{
    "result": [
        {
            "matches": [
                {
                    "type": "spelling",
                    "offset": X1,
                    "length": Y1,
					"ud": true,
                    "suggestions": ["..."]
                }
            ]
        }
    ]
}

Code Block

language	js
theme	Emacs
title	Type: Grammar

{
    "result": [
        {
            "matches": [
                {
                    "type": "grammarspelling",
                    "offset": X25,
                    "length": Y25,
                    "rulesuggestions": "...",[
                        "message": "...sample",
                        "sampled",
                    "suggestions": ["..."]    "sampler",
                }        "samples",
            ]
            }"ample",
    ]
}

Example 1.1 [GET]: Check request for American English text with all available check types (output in JSON)

Code Block

title	Request URL (GET):

http(s)://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=json&customerid=encrypted_customer_ID

Parameters:

Command: check
Text: this sampl text demonstrates the work of the Web API service.
Language: en_US
Format: json

Request Response:

Code Block

language	js
theme	Emacs

{
    "result": [
                      "amply",
       {
             "matches": [
   "scamp",
             {
           "stamp"
         "type": "spelling",
          ]
          "offset": 5,
     },
               "length": 5, {
                    "suggestionstype": ["grammar",
                        "sampleoffset": 0,
                        "sampled""length": 4,
                        "sampler"rule": "UPPERCASE_SENTENCE_START",
                    "message": "This sentence does "samples",
not start with an uppercase letter",
                    "amplesuggestions",: [
                        "amplyThis",
                    ]
    "scamp",
            }
            "stamp"]
        },
            ]{
                },"matches": [
                {
                    "type": "grammar",
                    "offset": 04,
                    "length": 411,
                    "rule": "UPPERCASEIT_SENTENCE_STARTVBZ",
                    "message": "ThisDid sentenceyou does not start with an uppercase lettermean demonstrates?",
                    "suggestions": [
                        "Thisdemonstrates"
                    ]
                }
            ]
        }
    ]
}

Example 1.

...

4 [GET]: Check request for American English text as two tokens with all available check types and shorntened response (output in

...

JSON)

Code Block

title	Request URL (GET):

http(s)https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgiapi?cmd=check&texttokens=["this sampl text demonstrates.", " It demonstrate the work of the Web API service."]&lang=en_US&formatshort_answer=xmltrue&customerid=encrypted_customer_ID[your-service-id]

Parameters:

Command: check
Text
Tokens: ["this sampl text
demonstrates
.", " It demonstrate the work of the Web API service."]
Language: en_US
Format:
xml
json
Short Answer: true

Request Responseresponse:

Code Block

language	xmljs
theme	Emacs

<result>
	<result>
		<matches>
			<matches>
				<type>spelling</type>
				<offset>5</offset>
				<length>5</length>
				<suggestions>
					<suggestions>sample</suggestions>
					<suggestions>sampled</suggestions>
					<suggestions>sampler</suggestions>
					<suggestions>samples</suggestions>
					<suggestions>ample</suggestions>
					<suggestions>amply</suggestions>
					<suggestions>scamp</suggestions>
					<suggestions>stamp</suggestions>
				</suggestions>
			</matches>
			<type>grammar</type>
			<offset>0</offset>
			<length>4</length>
			<rule>UPPERCASE_SENTENCE_START</rule>
			<message>This sentence does not start with an uppercase letter</message>
			<suggestions>
				<suggestions>This</suggestions>
			</suggestions>
		</matches>
	</result>
</result>

Example 1.3 [GET]: Check request for American English text as two tokens with all available check types (output in JSON)

Code Block

title	Request URL (GET):

https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=check&tokens=["this sampl text.", " It demonstrate the work of the Web API service."]&lang=en_US&customerid=encrypted_customer_ID

Parameters:

Command: check
Tokens: ["this sampl text.", " It demonstrate the work of the Web API service."]
Language: en_US
Format: json

Request Response:

Code Block

language	js
theme	Emacs

{
    "result": [{
    "r": [
        {
            "m": [
                {
                    "t": "spelling",
                    "o": 5,
                    "l": 5,
                    "s": [
                        "sample",
                        "sampled",
                        "sampler",
                        "samples",
                        "ample",
                        "amply",
                        "scamp",
                        "stamp"
                    ]
                },
        {
        {
    "matches": [
                {"t": "grammar",
                    "typeo": "spelling"0,
                    "offsetl": 54,
                    "lengthr": 5"UPPERCASE_SENTENCE_START",
                    "suggestionsm": [
     "This sentence does not start with an uppercase letter",
                    "samples",: [
                        "sampledThis",
                    ]
    "sampler",
            }
            "samples",]
        },
        {
        "ample",
    "m": [
                   "amply",{
                        "scamp"t": "grammar",
                        "stampo": 4,
                    ]"l": 11,
                },
                {"r": "IT_VBZ",
                    "typem": "grammarDid you mean demonstrates?",
                    "offsets": 0,
                 [
   "length": 4,
                    "rule": "UPPERCASE_SENTENCE_START",demonstrates"
                    "message": "This sentence does not start with an uppercase letter",
]
                }
             "suggestions": []
        }
                "This"
                    ]
                }
            ]
        },]
}

Example 1.4 [POST]: Check request for American English text with all available check types (output in JSON)

Here we use the same request and parameters as described in example 1.1 but form it as a POST request.

Code Block

title	Request URL (POST):

https://svc.webspellchecker.net/api?

Code Block

title	Body (Raw):

cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=json&customerid=[your-service-id]

Request response:

Code Block

language	js
theme	Emacs

{
    "result": [
        {
            "matches": [
                {
                    "type": "grammarspelling",
                    "offset": 45,
                    "length": 115,
                    "rulesuggestions": "IT_VBZ",[
                    "message": "Did you mean demonstrates?"sample",
                        "suggestionssampled": [,
                        "demonstratessampler",
                      ]  "samples",
                }
        "ample",
                ]        "amply",
        }
      ]
}

Example 1.4 [GET]: Check request for American English text as two tokens with all available check types and shorntened response (output in JSON)

Code Block

title	Request URL (GET):

https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?cmd=check&tokens=["this sampl text.", " It demonstrate the work of the Web API service."]&lang=en_US&short_answer=true&customerid=encrypted_customer_ID

Parameters:

Command: check
Tokens: ["this sampl text.", " It demonstrate the work of the Web API service."]
Language: en_US
Format: json
Short Answer: true

Request Response:

Code Block

language	js
theme	Emacs

{
    "r": [
 "scamp",
                        "stamp"
                    ]
                {},
            "m": [
                {
                    "ttype": "spellinggrammar",
                    "ooffset": 50,
                    "llength": 54,
                    "srule": ["UPPERCASE_SENTENCE_START",
                    "message": "This sentence  "sample",
    does not start with an uppercase letter",
                    "sampledsuggestions",: [
                        "samplerThis",
                        "samples",]
                        "ample",}
            ]
            "amply",}
                        "scamp",
                        "stamp"
                    ]
                },
                {
                    "t": "grammar",
                    "o": 0,
                    "l": 4,
                    "r": "UPPERCASE_SENTENCE_START",
                    "m": "This sentence does not start with an uppercase letter",
                    "s": [
                        "This"
                    ]
                }
            ]
        },
        {
            "m": [
                {
                    "t": "grammar",
                    "o": 4,
                    "l": 11,
                    "r": "IT_VBZ",
                    "m": "Did you mean demonstrates?",
                    "s": [
                        "demonstrates"
                    ]
                }
            ]
        }
    ]
}

Example 1.4 [POST]: Check request for American English text with all available check types (output in JSON)

Here we use the same request and parameters as described in example 1.1 but form it as a POST request.

Code Block

title	Request URL (POST):

https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgi?

Code Block

title	Body (Raw):

cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=json&customerid=encrypted_customer_ID

Request Response:

]
}

Example 1.5 [POST]: Check request for text with the auto-detected language (output in JSON)

In this POST type request, we use “auto” as a value for language and define the priorities for the language dialects. If “en” is detected, then AI-based English will be used during check request.

Code Block

title	Request URL (POST):

https://svc.webspellchecker.net/api?

Code Block

title	Body (Raw):

cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=auto&format=json&customerid=[your-service-id]&auto_lang_priorities={"en":"en_AI"

Code Block

language	js
theme	Emacs

{
    "result": [
        {
            "matches": [
                {
                    "type": "spelling",
                    "offset": 5,
                    "length": 5,
                    "suggestions": [
                        "sample",
                        "sampled",
                        "sampler",
                        "samples",
                        "ample",
                        "amply",
                        "scamp",
                        "stamp"
                    ]
                },
                {
                    "type": "grammar",
                    "offset": 0,
                    "length": 4,
                    "rule": "UPPERCASE_SENTENCE_START",
                    "message": "This sentence does not start with an uppercase letter",
                    "suggestions": [
                        "This"
                    ]
                }
            ]
        }
    ]
}

Content

Space Tools

Versions Compared

Old Version 13

New Version Current

Key

Example 1.1 [GET]: Check request for American English text with

all available check types (

output in JSON)

Example 1.2 [GET]: Check request for American English text with all available check types (output in XML)

Example 1.3 [GET]: Check request for American English text as two tokens with all available check types (output in JSON)

Response Structure

Example 1.1 [GET]: Check request for American English text with all available check types (output in JSON)

Example 1.

4 [GET]: Check request for American English text as two tokens with all available check types and shorntened response (output in

JSON)

Example 1.3 [GET]: Check request for American English text as two tokens with all available check types (output in JSON)

Example 1.4 [POST]: Check request for American English text with all available check types (output in JSON)

Example 1.4 [GET]: Check request for American English text as two tokens with all available check types and shorntened response (output in JSON)

Example 1.4 [POST]: Check request for American English text with all available check types (output in JSON)

Example 1.5 [POST]: Check request for text with the auto-detected language (output in JSON)