Response and HTTP Status Codes

The payload is a JSON object on success. This object is either a hash for single resources (such as show) or a list of hashes for multiple resources (such as list).

Standard HTTP status codes are used:

  • 200 OK - The request has succeeded

  • 401 Unauthorized - Your credentials are invalid

  • 403 Forbidden - You do not have access to the resource

  • 404 Not Found - The resource could not be found

  • 412 Precondition Failed - The request could not be completed because of a validation error

  • 500 Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request.

  • 503 Service Unavailable - The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.