SpellCheck service Http API (7.10.4)

Download OpenAPI specification:Download

Documentation of the OX Software GmbH SpellCheck service Http API.


SpellCheck

The SpellCheck service module.

Paragraph spelling request

post /check-paragraph-spelling
http://example.com:8003/check-paragraph-spelling

Check spelling of the given paragraphs, using the given locales.

Request Body schema: application/json
paragraph
Array of objects

Paragraphs consisting of texts to check spelling for.

Responses

200

The spelling result for the given paragraphs, using the given locales.

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "paragraph":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "spellResult":
    [
    ]
}

Text spelling request

post /check-spelling
http://example.com:8003/check-spelling

Check spelling of the given text using the given locale.

Request Body schema: application/json
locale
string

The locale to be used to check the spelling of the given text.

text
string

The text to check spelling for, using the given locale and required language encoding of the used dictionary.

offset
integer

Offset that is added to the appropriate character position within the response for detected, misspelled words.

noReplacements
boolean
Default: false

Optional property to specify if replacments should be retrieved and returned for the current request. Default is set to false, so that replacements are returned if not specified.

Responses

200

The spelling result for the given text, using the given locale.

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "locale": "string",
  • "text": "string",
  • "offset": 0,
  • "noReplacements": false
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "spellResult":
    [
    ]
}

Server Health Request

get /health
http://example.com:8003/health

Getting the current health status of the SpellCheck service.

Responses

200

The health status of the SpellCheck service.

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "health":
    {
    }
}

Misspelled request

post /is-misspelled
http://example.com:8003/is-misspelled

Checking if a word is misspelled, using the given locale.

Request Body schema: application/json
locale
string

The locale to be used to check the spelling of the given word.

word
string

The word to check spelling for, using the given locale and required language encoding of the used dictionary.

Responses

200

The boolean result of the spell check operation, using the given locale.

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "locale": "string",
  • "word": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "spellResult": true
}

Suggested replacements request

post /suggest-replacements
http://example.com:8003/suggest-replacements

Retrieving the suggested replacements for a given word, using the given locale.

Request Body schema: application/json
locale
string

The locale to be used to check the spelling of the given word.

word
string

The word to check spelling for, using the given locale and required language encoding of the used dictionary.

Responses

200

The suggested replacements for a misspelled word, using the given locale.

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "locale": "string",
  • "word": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "spellResult":
    [
    ]
}

Supported locales request

get /supported-locales
http://example.com:8003/supported-locales

Retrieving all locales that are supported to be used for spell check requests.

Responses

200

The supported locales for all spell check related requests.

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "spellResult":
    [
    ]
}