The help desk's API uses conventional HTTP response codes to indicate the success or failure of an API request. Response codes in the
2xx range indicates success. Codes in the
4xx range indicates a failure due issues on the request provided (e.g., required parameter is missing, maximum parameter length reached, etc). Codes in the
5xx range indicates a server side error, if you are using the self-hosted application, you should check your app's log files to see what happened.
Here's a list of all the HTTP codes used and their meaning:
|Success -- Everything went smoothly.
|Created -- Resource was created successfully.
|No Content -- Everything went smoothly and an empty response was given. Commonly used when deleting resources.
|Bad Request -- Your request is invalid.
|Unauthorized -- Your API Access Token is wrong.
|Forbidden -- You are not allowed to access the requested resource.
|Not Found -- The requested resource could not be found.
|Method Not Allowed -- You tried to access a resource with an invalid HTTP method. For example, sending a
POST request on a
GET only endpoint.
|Not Acceptable -- You requested a format that isn't json.
|Unprocessable entity -- There are validation errors that you should fix.
|Too Many Requests -- You're requesting too many resources! Slow down!
|Internal Server Error -- There was a problem on the server.
|Service Unavailable -- Application is offline for maintenance.