}

/v1/proofing/check

https://api.reporting.cloud/v1/proofing/check

Checks text for spelling errors.

Spell Checking Quota

This method counts against the spell checking quota. For each request, the quota count is increased by 1.

Authorization

This endpoint requires a "ReportingCloud-APIKey" or a "Basic" user authorization to access the user acount, data and templates. Only one of these two methods are required.

ReportingCloud-APIKey
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

An API Key needs to be generated using the portal or /v1/account/apikey endpoint. The authorization method and a space i.e. "ReportingCloud-APIKey " is then put before the actual API Key string.

Sample:

Authorization: ReportingCloud-APIKey oMDM4MrAqL9QEOpyzupnQW5NjvCNtvE5cVDaaLqxI

Basic
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

The username and password are combined into a string separated by a colon, e.g.: username:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string.

Sample:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l


Request Parameters

Query Parameter Value Type Description
text String Specifies the text to spell check.
language String The language that is used to spell check the specified text.

Success Response

Return Value Description

200 (OK)

On success, the HTTP status code in the response header is 200 (OK). The response body contains an array of the created documents encoded as Base64 encoded strings.

IncorrectWord

Key Value Type Description
length Integer Gets the length of the spelled word.
start Integer Gets the starting position of a spelled word.
text String Gets the text of the spelled word.
isDuplicate Boolean Gets a value indicating whether the spelled word is declared as incorrect, because the previous word has the same text.
language String Gets a value indicating the language the incorrect word was spelled.

Error Response

Return Value Description

403 (Forbidden)

A 403 (Forbidden) is returned, if the user is not authorized or the proofing quota is exceeded.

Sample Requests

Request:

Results:

Request:

Request:

Results:

Get