Copy page

Guides

Responses

Success Status Codes

The following HTTP status codes are used for successful requests.

Error Status Codes

If there are any errors with the request, an error status code will be returned along with further details of the error in the response body as an array of JSON error objects.

Error Response Data

General

Example Response JSON

Code
[
  {
    "message": "Request method 'PUT' not supported"
  }
]

Some errors will simply return a text description of the error encountered, but will still follow the same data structure.

Error codes issued in payload responses:

Validation

A request data validation error will return the error code 422 and the following response

Example Response JSON

Code
[
  {
    "field": "/name",
    "message": "Name cannot be empty."
  },
  {
    "field": "/description",
    "message": "Description cannot be empty."
  }
]

Code
[
  {
    "field": "/references/customer",
    "message": "A Purchase Order with this Customer Reference already exists.",
    "type": "DUPLICATE",
    "details": {
      "duplicateId": "cd639009-1111-4a89-bf83-8907b8c9d09a"
    }
  }
]

An array of validation errors with the fields for which the error applies will be returned.

Validation Error Type