The response structure below is applicable to all error messages you may receive. The difference depends on the command used and the message returned. The HTTP 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error. Possible Cause Incorrect syntax; Incorrect spelling of command, parameter, or value name. Remediation Verify if the request command syntax is correct, and the command is not empty, Make sure the request message is framed correctly. For example, the following command has a syntax error in "check_spelling" command name: Remediation: Specify a correct command name. Tip: Refer to the list of available commands in Cloud Web API and Server Web API. For example, the command is unspecified: Remediation: specify the command value. For example, the parameter key is invalid: Remediation: specify a correct parameter key. The HTTP 403 Forbidden client error status response code indicates that the server understood the request but refuses to authorize it. Some issues usages or occurrences d in the response, for example: In most cases an error description provides the exact cause of the issue and solution on how to fix the issue in response on your side. Example of incorrect customer ID: Remediation: request a new/valid customer ID. Example of expired customer ID: Remediation: request a new/valid customer ID. Example of the list of unallowed domains: Remediation: Verify the subscription covers the domain where you are using WebSpellChecker. Example of the subscription key which is either turned off or does not exist yet: Remediation: Contact our support team for details. The HTTP 500 Internal Server Error server error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. This error response is a generic "catch-all" response. Usually, this indicates the server cannot find a better 5xx error code to response. This error usually denotes some situation when the server is not aware of how to handle it properly. It can be for example, any exceptions of the server logic including all hardware issues. If the error message doesn't give clear steps to fix the issue, contact our support team at [email protected]. The HTTP 503 Service Unavailable server error response code indicates that the server is not ready to handle the request. You may encounter this error in the following cases: Verify the server license and update/request new license if it is necessary. Also contact our support team at [email protected]
HTTP response status codes described in this section indicate whether a specific HTTP request has been successfully completed. Refer to their descriptions below when integrating WebSpellChecker into your applications and testing REST API. This section covers: Response Structure
{
"error": true,
"is_critical": 0,
"message": "...",
"command": "..."
}
400 Bad Request
Example 1. Command Syntax Error Issue
{
"error": true,
"is_critical": 0,
"message": "The command value 'check_spellin' for 'cmd' parameter is unknown. Check available commands.
Contact [email protected] for more details.",
"command": "check_spellin"
}
Unspecified Command Issue
{
"error": true,
"is_critical": 0,
"message": "The command value for 'cmd' parameter is not specified in your request.
Contact [email protected] for more details.",
"command": ""
}
Invalid Parameter Key Issue
{
"error": true,
"is_critical": 0,
"message": "The command value for 'cmd' parameter is not specified in your request.
Contact [email protected] for more details.",
"command": ""
}
403 Forbidden
Possible Cause
Remediation
Incorrect Customer ID Issue
{
"error": true,
"is_critical": 0,
"message": "An incorrect value is used for the service ID parameter. To access the service,
Cloud customers are required to use a key which they received in the 'config.ini' file which is attached
to the subscription email or 'Download configuration file' from the account panel on the webspellchecker.com website.
(Decoded data too short to contain the main chunk body)",
"command": "check_spelling"
}
Expired Customer ID Issue
{
"error": true,
"is_critical": 0,
"message": "The request from '' has failed. '' is not in the list of allowed domains for this subscription.
Check the list of allowed domains in your subscription management panel.",
"command": "check_spelling"
}
Unallowed Domains Issue
{
"error": true,
"is_critical": 0,
"message": "The request from '' has failed. '' is not in the list of allowed domains for this subscription.
Check the list of allowed domains in your subscription management panel.",
"command": "check_spelling"
}
Subscription Key Issue
{
"error": true,
"is_critical": 0,
"message": "Your subscription to the service is disabled or doesn't exist. Contact [email protected] for more details.",
"command": "check_spelling"
}
500 Internal Server Error
Possible Cause
Remediation
503 Service Unavailable
Possible Cause
Remediation