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.1. Command Error IssueFor example, the following has an error in "check_spelling" command name:
Remediation: Specify a correct command name. Refer to the list of available commands in Web API Cloud and Web API Server. Example 1.2. Unspecified CommandFor example, the command in the request wasn't specified:
Remediation: Specify the command value. 403 ForbiddenThe HTTP 403 Forbidden client error status response code indicates that the server understood the request but refuses to authorize it. Possible Causes Some issues usages or occurrences in the response, for example:
Remediation 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 2.1. Incorrect Customer IDExample of an incorrect value used for a customer ID parameter:
Remediation: Check the value used in the customer ID parameter and make sure that you have copied and pasted the whole key without any extra characters. Please note that “1:” is also a part of your activation key. Example 2.1. Expired SubscriptionExample of an expired customer ID:
Remediation: Renew the service subscription. Unallowed Domains IssueExample of an attempt to use the service on the domain(s) where the use is not granted:
Remediation: Verify the subscription covers the domain where you are using the service. Contact [email protected] to whitelist a domain for your subscription. Subscription Key IssueExample of the subscription key which is either turned off or does not exist yet:
Remediation: Contact our support team for details. If you have just subscribed to the Cloud services, please allow up to 5-10 mins for the changes to take effect. 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 CausesYou may encounter this error in the following cases:
RemediationVerify the server license and update/request new license if it is necessary. If you are a holder of the self-hosted, Server version of WebSpellChecker, check if you have any errors in the logs which are located AppServer/Logs folder. Also contact our support team at [email protected]. |