Versions Compared

Old Version 9

changes.mady.by.user user-4a6d8

Saved on

compared with

New Version 10

changes.mady.by.user user-4a6d8

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Edited entry 17 text in the table description.

...

#ParameterPossible ValuesDefault ValueDescription
1format
  • json
  • xml
jsonThe response format for output data.
2callback
  • callback function name

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

A piece of text which will be sent for check. The text has to be in the UTF-8 encoding. Any found tags in the text will be interpreted as plan text as well.

Note
Avoid using # and & symbols in the text.


4tokens
  • Array of strings, e.g. ["This is a sentence number 1.", "This is a sentence number 2."]

A piece of 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.


5langen_USA short code of a language which will be used for check.
6disable_spelling
  • true
  • false
falseDisable the check text for spelling errors.
7disable_grammar
  • true
  • false
falseDisable the check text for grammar and style problems.
8user_dictionary
  • user dictionary name (e.g. testdict)

A user dictionary name which will be used during check spelling.

9user_wordlist
  • additional wordlist

The list of additional comma-separated words which will be used for spell checking.

10custom_dictionary
  • custom dictionary IDs (e.g. 100694)

Global custom dictionary ID(s) which can be used during check spelling.

Info

Each new Dictionary on the creation obtains its unique Dictionary ID. Depending on the type of the version of product you are using, refer to Cloud or Server guides respectively.


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

Ignore capitalized words.

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

Ignore words containing numbers.

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

Ignore words written with mixed case letters.

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

Ignore domain names, web addresses.

15min_word_length
  • minimal number of letters in a word to be checked
3

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.

16custom_punctuation
  • string of chars (e.g. “-“)
-

A list of characters that should be considered as delimiters during spelling check.

17short_answer
  • true
  • false
false

Enables shortening Shorten every static string JSON key name, like messages or type down to its first character, for example: 

  • m - matches, message
  • o - offset
  • l - length
  • t - type
  • r - rule
  • s - suggestions
18customerid
  • encrypted_customer_ID value

A special customer ID value (activation key) that has to be passed to a request query. It's obtained upon subscription to the Cloud services (paid or trial).

Warning

Applicable only for the Cloud version.


...