Error responses

Unsuccessful requests are responded with HTTP status codes in the 400 range. The response may be content type text/plain for API level error messages (e.g when trying to call the API without valid user credentials). The error response has content type application/json for business level error messages. The latter contains a JSON formatted error messages to supplement the HTTP status code.

For example:

{
  “error”:         “RecordInvalid”,
  “description”:   “RecordValidation errors”,
  “details”: {
     “fields”: [
       {
          “field_name”:   “first_name”,
          “error”:        “blank”,
          “description”:  “can’t be blank”
       },
       {
          “field_name”:   “last_name”,
          “error”:        “blank”,
          “description”:  “can’t be blank”
       }
     ]
   }
}

HTTP status code in the 500 range may be returned in case of internal server issue. Contact system administrator to troubleshoot the issue.