Errors

This section provides details on the data object that reflects the API's common response to error cases, and lists the API's range of response status codes for both error and success cases.

The top-level error object contains type, title, instance, status, problemId, and optionally, errors. The second-level error objects contain type and title. Additional fields for debugging may be included in both top- and sub-level error objects where applicable.

{
  "type": "validation.error",
  "title": "Validation error",
  "instance": "e4bdb007-213d-4573-ab76-4f071b55de59",
  "status": 400,
  "errors": [
    {
      "type": "required.field.missing",
      "title": "Required field missing",
      "requestField": "propertyName"
    }
  ],
  "problemId": "f4bdb007-213d-4599-ab76-4f071b3fc129"
}

For details on information contained in the error responses, refer to Error response syntax.