Error responses

When a client made an API request which the server could not process successfully, an error response is returned. The error response contains an error code, a short message describing the error and sometimes a map containing a set of resource's fields what the error(s) are related to. The response also contains an appropriate 4xx or 5xx HTTP response code.

An example error response:

  Response code 400 (Bad request)
  {
    "message": "Validation failed",
    "code": "00018",
    "fields": {
      "finish": "Please enter a valid date.",
      "accepterPerson": "Please enter a valid number.",
      "person": "Please enter a valid number."
    }
  }

The error code can be used to query for a user friendly error message in user's default language via the enumerations and languages resources.

All possible error codes and their corresponding language strings can be found under

/enumerations?section=System.API.Errors

More information about /enumerations and /languages in the API documentation .