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

Info
Command name: check

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

...

json
xml

...

callback function name

...

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

...

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

...

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

...

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.

...

plain text

...

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

...

user dictionary name (e.g. testdict)

...

additional wordlist

...

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

...

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.

...

)

Code Block

title	Request URL (GET):

http(s)https://svc.webspellchecker.net/spellcheck31/script/ssrv.fcgiapi?cmd=check_spelling&format=xml&text=Thistokens=["this sampl text demonstrates.", " It demonstrate the work of the WebSpellChecker Web API service."]&out_type=words&slang=lang=en_US&customerid=[encrypted_customer_IDyour-service-id]

Parameters:

Command:
check
check
Format: XML
Text: “This sampl text demonstrates
Tokens: ["this sampl text.", " It demonstrate the work of the
WebSpellChecker
Web API service.
”Output: words
"]
Language:
American English (
en_US
)
Format: json

Request Responseresponse:

Code Block

language	xmljs
theme	Emacs

<?xml version="1.0" encoding="utf-8"?>
<check_spelling>
    <misspelling>
{
    "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"
                    ]
                }
            ]
        },
        {
            "matches": [
                <word>sampl</word>
{
                  <ud>false</ud>
  "type": "grammar",
                 <suggestions>
    "offset": 4,
               <suggestion>sample</suggestion>
     "length": 11,
                    <suggestion>sampled</suggestion>"rule": "IT_VBZ",
            <suggestion>sampler</suggestion>
        "message": "Did you mean demonstrates?",
                     <suggestion>samples</suggestion>"suggestions": [
            <suggestion>ample</suggestion>
            "demonstrates"
                   <suggestion>amply</suggestion> ]
            <suggestion>scamp</suggestion>    }
            <suggestion>stamp</suggestion>]
        </suggestions>}
    </misspelling>
</check_spelling>]
}

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_spelling&format=json&text=Thistokens=["this sampl text demonstrates.", " It demonstrate the work of the WebSpellChecker Web API service."]&out_type=words&slang=lang=en_US&short_answer=true&customerid=[encrypted_customer_IDyour-service-id]

Parameters:

Command:
check_spelling
Format: JSON
check
Tokens: ["this sampl text.", " It demonstrate
Text: “This sampl text demonstrates
the work of the
WebSpellChecker
Web API service.
”Output: words
"]
Language:
American English (
en_US
)
Format: json
Short Answer: true

Request Responseresponse:

Code Block

language	js
theme	Emacs

{
    "r": [
        {
            "m": [
                {
                    "wordt": "spelling",
                    "samplo": 5,
         "ud           "l": false5,
                    "suggestionss": [
                        "sample",
                        "sampled",
                        "sampler",
                        "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 above 1.1 but form it as a POST request.

Code Block

title	Request URL (GETPOST):

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

Code Block

title	Body (Raw):

cmd=check_spelling&format=json&text=Thisthis sampl text demonstrates the work of the WebSpellChecker Web API service.&out_type=words&slang=lang=en_US&format=json&customerid=[encrypted_customer_IDyour-service-id]

Request Responseresponse:

Code Block

language	js
theme	Emacs

{
    "result": [
        {
            "matches": [
                {
              "word      "type": "sampl",
"spelling",
                    "offset": 5,
                    "udlength": false5,
                    "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.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"}

Content

Space Tools

Versions Compared

Old Version 1

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

)

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)