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 CodeMessageDescription
200OKThe request was received successfully.
201CreatedThe 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:

ElementDescription
StatusCodeThe HTTP error code.
ContentA 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 CodeMessageDescription
400Bad RequestThe 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).
401UnauthorizedAlthough the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
403ForbiddenThe 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.
404Not FoundThe server can not find the requested resource. In the browser, this means the URL is not recognized.
429Too Many RequestsThe user has sent too many requests in a given amount of time ("rate limiting").
500Internal Server Error/Not ClosedThe server has encountered a situation it does not know how to handle.
503Service UnavailableThis 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.