Standard Failure Response 📰

Imagen returns the following response in the body when calls fail (i.e. return code is neither 200 nor 201)

<?xml version="1.0" encoding="UTF-8"?> 
   <Error> 
      <Code></Code><!--Error code 0 = success --> 
      <Message></Message> 
      <Details></Details><!-- Further/lengthier details of the error (if there are any)--> 
   </Error>

JSON error response

For the cases where the API is to return JSON (i.e, the request has set the Accept header field value to application/JSON) then the error format is as follows:

{
    "Error": {
        "Message": /* ...The error message... */,
        "Details": /* ...Further/lengthier details of the error (if there are any).. */
     }
}