Skip to main content

Global API Errors

API errors allow specifying custom description of errors for the user corresponding to HTTP response codes other than 200. Errors can be defined at the global level in addition to errors defined for particular endpoints. Global API errors are applied across all endpoints.

Error Response Codes

The fields are described below:

Error Code#

This is the HTTP Status code of the error.

Error Message#

This is a description of what the status code means and any other relevant information that should be passed to the user when this error code is returned.

Exception Class#

This is the class of the exception thrown.

The dropdown allows you to select any of the models defined as an Exception type in your API definition. All properties of the exception class are populated by matching properties from the JSON response received from the API server.