Error Resource

The standard API error response resource is a JSON object, an example of which is as shown below.

{
 “message” : “Validation Failure”, 
 “transactionId” : “transactionId”,
 “errors”: [ 
  { 
    “resource”: “user”, 
    “field” : “email”, 
    “errorCode”: “missing_field”, 
    “message” : “Email is a required field.”, 
    “invalidValue” : “null” 
  } 
 ] 
}

Error Resource Properties

Property Name	Value	Description
message	string	An error message corresponding to the set of errors represented by the response
transactionId	string	transactionId of the request that resulted in the error response
errors	JSON object	An array of error objects
`resource`	string	The resource involved in the error scenario
field	string	The field of the resource involved in the error scenario (if applicable)
`message`	string	An error message corresponding to the specific error
`invalidValue`	string	The offending value that resulted in the error (if applicable)