Page History
...
Excerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 StructureThe response structure below is applicable to all error messages you may receive. The difference depends on the command used and the message returned.
400 Bad RequestThe 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
Remediation
Example 1. Command Syntax Error IssueFor example, the following command has a syntax error in "check_spelling" command name:
Remediation: Specify a correct command name.
Unspecified Command IssueFor example, the command is unspecified:
Remediation: specify the command value. Invalid Parameter Key IssueFor example, the parameter key is invalid:
Remediation: specify a correct parameter key. 403 ForbiddenThe HTTP 403 Forbidden client error status response code indicates that the server understood the request but refuses to authorize it. Possible CauseSome issues usages or occurrences d in the response, for example:
RemediationIn 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. Incorrect Customer ID IssueExample of incorrect customer ID:
Remediation: request a new/valid customer ID. Expired Customer ID IssueExample of expired customer ID:
Remediation: request a new/valid customer ID. Unallowed Domains IssueExample of the list of unallowed domains:
Remediation: Verify the subscription covers the domain where you are using WebSpellChecker. Subscription Key IssueExample of the subscription key which is either turned off or does not exist yet:
Remediation: Contact our support team for details. 500 Internal Server ErrorThe HTTP 500 Internal Server Error server error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. Possible CauseThis 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. RemediationIf the error message doesn't give clear steps to fix the issue, contact our support team at [email protected]. 503 Service UnavailableThe HTTP 503 Service Unavailable server error response code indicates that the server is not ready to handle the request. Possible CauseYou may encounter this error in the following cases:
RemediationVerify the server license and update/request new license if it is necessary. Also contact our support team at [email protected] |
...