Errors

The Thredd Cards API uses standard HTTP response status codes to indicate whether a request was successful or not.

If a request is unsuccessful, the response body contains details of the error within an error object to provide more information about what went wrong with the request.

In the example below, a user has tried to use the Thredd /cards/{publicToken}/pin endpoint and has passed an PIN in the request body. The result of the request is a 400 response with the following response body:

{
  "type": "https://docs-gps.readme.io/docs/card-personal-identification-number-pin"
  "title": "One or more validation errors occured",
  "status": 400,
  "traceId": "00-9228fab9562d2f4f821cc6511b121faa-7c5a55c30acf1d48-00",
  "errors": {
  	"resource": [
      	"Errors description"
   	 ]
  }
}

See below for details of error message fields:

• type: passes a URI to Thredd Documentation that could be relevant to the error
• title: contains a short human-readable summary of the error
• status: returns the HTTP code of the error
• traceId: returns a trace ID that can be used for debugging with Thredd support teams
• errors: this object contains an array of specific instances in which the error occurs

Response Error Codes