API Responses
HTTP Status Codes
Successful Requests
The web services return a HTTP 2xx response code when the request was successful.
HTTP Success Codes:
Success Code | Message | Description |
---|---|---|
200 | OK | The request was received successfully. |
201 | Created | The request was received successfully and led to the creation of a resource. |
Failed Requests
The API returns a 4xx or 5xx HTTP response code when there are any errors and will include the following elements:
Element | Description |
---|---|
StatusCode | The HTTP error code. |
Content | A parent element that contains an detail child element with a description of the error |
HTTP Error Codes
The full list of possible HTTP error codes can be found here. The table below provides additional details for commonly encountered error codes.
Error Code | Message | Description |
---|---|---|
400 | Bad Request | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
401 | Unauthorized | Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. |
403 | Forbidden | The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. |
404 | Not Found | The server can not find the requested resource. In the browser, this means the URL is not recognized. |
429 | Too Many Requests | The user has sent too many requests in a given amount of time ("rate limiting"). |
500 | Internal Server Error/Not Closed | The server has encountered a situation it does not know how to handle. |
503 | Service Unavailable | This response is returned when the web service is down for maintenance or we are experiencing unplanned downtime. Please consult our (status page)[https://fairo.statuspage.io] for the most up-to-date information. |
Updated 12 months ago