Type error

Discussion

This type is used to describe the errors that can be returned by the API.

It is not expected that many applications will concern themselves with this type. It is made available for development and testing purposes.

Note that the field-name description for each record returned differs from the field-name error_message that is part of the common response wrapper on individual API requests.

Fields

description
string

error_id
integer, refers to an error

error_name
string

Fields marked with are included in the default filter, those marked with are excluded in the default filter.

Examples

Bad Parameter

{"error_id":400,"description":"A malformed parameter was passed","error_name":"bad_parameter"}

Methods That Return This Type