/
HTTP Status Codes

HTTP Status Codes

Specified below is a list of HTTP Status codes an API implementer can expect to encounter when using the Public API.

200 "OK"

Conditions for use:

  1. The request was successful.
    1. Example: [GET] /api/v1/car/1
    2. Example: [PUT] /api/v1/car/1?name=Mazda323
    3. Example: [DELETE] /api/v1car/1 "Delete with a response"

201 "Created"

Conditions for use:

  1. The request to create was successful.
    1. Example [POST] /api/v1/car/?name=Mazda2

204 "No Content"

Conditions for use:

  1. The request to delete was successful and no further response will be return by server.
    1. Example: [DELETE] /api/v1/car/1 "Delete no response" This http status has been deprecated in favour of returning 404 if the identifier not longer exists.

404 "Not found"

Conditions for use:

  1. The resource does not exist. Example: /api/v1/doesNotExists
  2. The member does not exist. Example: /api/v1/car/999999
  3. A delete request of a resource that no longer exists: Example DELTE /api/v1/car/1

403 "Forbidden"

Conditions for use:

  1. The request is not authorised to use the method.

400 "Bad Request"

Conditions for use:

  1. The request did not pass input validation.

418 "I'm a teapot (RFC 2324)"

Conditions for use:

  1. IE Point 6 or IE Point 7 is used to make the request. 

429 "Too Many Requests"

Conditions for use: 

  1. The request has exceeded the allowed limits of requests for a given time period.

500 "Internal Server Error"

Conditions for use:

  1. The request experienced an internal server error.

503 "Service Unviable"

Conditions for use:

  1. The server is not currently accepting requests.

Related content

Terminology
Terminology
More like this
Rate Limiting
Rate Limiting
More like this
Rate Limiting
Rate Limiting
More like this
Animal Statuses /api/animalStatuses
Animal Statuses /api/animalStatuses
More like this
Content types (Content-Type, Accept)
Content types (Content-Type, Accept)
More like this
Datatypes & Naming Conventions
Datatypes & Naming Conventions
More like this