Ozow Hub

Error

A standard [JSON API error](https://jsonapi.org/format/#errors)

On this page2 sections

Fields

  • id string uuid required

    a unique identifier for this particular occurrence of the problem.

  • links object nullable

    Present on an authentication or authorisation failure, and null otherwise.

    • about string uri

      A link that leads to further details about this particular occurrence of the problem. When derefenced, this URI SHOULD return a human-readable description of the error.

    • type string uri

      A link that identifies the type of error that this particular error is an instance of. This URI SHOULD be dereferencable to a human-readable explanation of the general error.

  • code string required

    An application-specific error code, expressed as a string value. Key on this rather than on title or detail, which are written for a person. A rejection at the transport level uses the status name, one of BadRequest, Unauthorized, Forbidden, NotFound, NotAllowed, Conflict, UnsupportedMediaType, BadGateway or InternalServerError. An operation refusing a request on its own rules returns a code of its own.

  • title string required

    A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

  • detail string required

    A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

  • source object nullable

    Where in the request the problem was found. All three keys are present whenever source is, with the ones that do not apply set to null. source itself is null where the failure is not about a part of the request.

    • pointer string json-pointer nullable

      a JSON PointerJSON Pointer A path into a JSON document, written as /data/attributes/title. An error response uses one to say exactly which value caused the problem.RFC 6901 RFC6901 to the value in the request document that caused the error [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. This MUST point to a value in the request document that exists; if it doesn’t, the client SHOULD simply ignore the pointer.

    • parameter string nullable

      A string indicating which URI query parameter caused the error.

    • header string nullable

      A string indicating the name of a single request header which caused the error.

  • meta object nullable

    A meta object containing non-standard meta-information about the error. Null where the request carried no X-Correlation-ID, and on an authentication failure, which does not echo it.

    • correlationId string

      The X-Correlation-ID sent with the request, echoed back so it can be quoted to support. Absent when the request carried no correlation header.

Used by