Date: Thu, 28 Mar 2024 12:37:40 +0200 (EET) Message-ID: <1328631663.592.1711622260984@ip-172-30-3-56.ec2.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_591_832573024.1711622260980" ------=_Part_591_832573024.1711622260980 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
HTTP response status codes de= scribed in this section indicate whether a specific HTTP request has been s= uccessfully completed. Refer to their descriptions below when integrating W= ebSpellChecker into your applications and testing REST API.
The response structure below is appli= cable to all error messages you may receive. The difference depends on the = command used and the message returned.
{
=09"error": true,
=09"is_critical": 0,
=09"message": "...= ",
=09"command": "..."
}
The HTTP 400 Bad Request respon= se status code indicates that the server cannot or will not process the req= uest due to something that is perceived to be a client error.=
Possible cause = strong>
Incorrect syntax;
Incorrect spelling of command, pa= rameter, or value name.
Remediation= p>
Verify if the request command syn= tax is correct, and the command is not empty,
Make sure the request message is = framed correctly.
For example, the following has an err= or in "check_spelling" command name:
{
=09"error": true,
=09"is_critical": 0,
=09"message": "Th= e command value 'check_spellin' for 'cmd' parameter is unknown.
=09Chec= k available commands. Contact support@webspellchecker.net = for more details.",
=09"command": "check_spellin"
}
Remediation: Specify= a correct command name. Refer to the list of available commands = in Web API Cloud and Web API Server.
For example, the command in the reque= st wasn't specified:
{
=09"error": true,
=09"is_critical": 0,
=09"message": "Th= e command value for 'cmd' parameter is not specified in your request.
= =09Contact support@webspellchecker.net for more details.",=
=09"command": ""
}
Remediation: Specify= the command value.
The HTTP 403 Forbidden client error s= tatus response code indicates that the server understood the request but re= fuses to authorize it.
Possible causes
Some issues usages or occurrences in = the response, for example:
Language is disabled/unallowed;&n= bsp;
Service on the unallowed domain;&= nbsp;
Command, check type unallowed; fo= r example, grammar checking command is not available under free services.= span>
Product unavailable for the given= license;
Exceeded usage limitations;
Service subscription expiration.<= /span>
Remediation= p>
In most cases an error description pr= ovides the exact cause of the issue and solution on how to fix the issue in= response on your side.
Example of an incorrect value used fo= r a service/customer ID parameter:
{ =09"error": true,
=09"is_critical": 0,
=09"message": "Servic= e key is incorrect.", "command": "check"
}
Remediation: = Check the value used in the servic= e/customer ID parameter and make sure that you have copied and pasted the w= hole key without any extra characters. For older versions, please note that= =E2=80=9C1:=E2=80=9D is also a part of your activation ke= y.
Example of an expired customer ID:&nb= sp;
{ =09"error": true,
=09"is_critical": 0,
=09"message": "Subscr= iption expired. Contact support@webspellchecker.net for mo= re details.",
=09"command": "check"
}
Remediation: Renew the service subscription.
Example of an attempt to use the serv= ice on the domain(s) where the use is not granted:
{
=09"error": true,
=09"is_critical": 0,
=09"message": "Re= quests from 'scayt.com' are not allowed. Check domain permissions. Contact <= span style=3D"color: rgb(0,0,0);">support@webspellchecke= r.net for more details.",
=09"command": "check"
}=
Remediation: Verify =
the subscription covers the domain where you are using the service. C=
ontact support@webspellchecker.net
Example of the subscription key which= is either turned off or does not exist yet:
{
=09"error": true,
=09"is_critical": 0,
=09"message": "Su= bscription is disabled or doesn't exist. Contact support@websp= ellchecker.net for more details.",
=09"command": "check"
}
Remediation: C= ontact our support team for details. If you have just subscribed to the Clo= ud services, please allow up to 5-10 mins for the changes to take effe= ct.
The HTTP 500 Internal Server Error se= rver error response code indicates that the server encountered an unexpecte= d condition that prevented it from fulfilling the request.
This error response is a generic "cat= ch-all" response. Usually, this indicates the server cannot find a better 5= xx error code to respond. Th= is 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 gi= ve clear steps to fix the issue, contact our support team at support@webspellchecker.net.
The HTTP 503 Service Unav= ailable server error response code indicates that the server is not ready t= o handle the request.
You may encounter this error if the&n= bsp;license is invalid.
Verify the server license and u= pdate/request new license if it is necessary. If you are a holder of the se= lf-hosted, Server version of WebSpellChecker, check if you have any errors = in the logs which are located AppServer/Logs folder. = Also contact our sup= port team at support@webspellchecker.net.