All errors returned from the FrankieOne API will be wrapped up in a standard format error object.

ErrorObject

The ErrorObject consists of the following attributes:

  • ErrorCode: One of the standard error codes (see below)
  • ErrorMsg: A human readable message describing the error
  • HttpStatusCode: The HTTP result code
  • Issues:- An array of additional error helpers, used to define where errors have occurred. Each element in the array consist of:
    Issue: Description of the issue
    IssueLocation: The location in the payload or process where the issue was found/occurred
{
  "commit":"2af478ed"
  "errorCode":"CORE-5990"
  "errorMsg":"Everything went kaflooey. Stay clam."
  "httpStatusCode":501
  "issues":[
    {
    "issue":"Invalid format. Must be YYYY-MM-DD"
    "issueLocation":"dateOfBirth"
    }
  ]
  "requestId":"01BFJA617JMJXEW6G7TDDXNSHX"
}

See the Full List of Error Codes


Did this page help you?