Errors

Our APIs may raise errors for many reasons, such as a failed pathing, invalid parameters, authentication errors, and network unavailability. When a request returns an error, the system will provide a message to indicate more details about the failure. If there are particular errors found, they will be listed in the Errors array. Note that the Errors array is optional and will only be present when detailed error information is available.

HTTP Status Code Summary

While system errors are rare, we recommend writing code that gracefully handles all possible API exceptions. In many cases, these means implementing a retry mechanism with an exponential drop-off in frequency.

{
  "Status": "ERROR",
  "Message": "Validation Failed",
  "Errors": [
    {
      "Field": "AccountId",
      "Message": "Not a numeric value"
    }
  ]
}

<ImpactRadiusResponse>
    <Status>ERROR</Status>
    <Message>Validation Failed</Message>
    <Errors>
        <Error>
      <Field>AccountId</Field>
      <Message>Not a numeric value</Message>
    </Error>
    </Errors>
</ImpactRadiusResponse>