API Error Responses
In order to provide more informative error responses, our API methods return errors via an XML or JSON error object containing error_type and error_message attributes.
Make sure that your code is able to detect the error objects that may be delivered in our API response. Our API client libraries automatically detect these messages, and throw language-specific errors when they are encountered.
JSON Error Response Format
{
"error": {
"error_type": "Not Found",
"error_message": "No records were found with the given parameters."
}
}
XML Error Response Format
<?xml version="1.0" encoding="utf-8" ?> <error> <error_type>Not Found</error_type> <error_message>No such event.</error_message> </error>
Common Error Responses
| error_type | error_message |
|---|---|
| Request Error | Not a valid API command. Please check the documentation. |
| Request Error | The API request was not properly formed. |
| Application Key Error | Please provide your Application Key in the URL as “?app_key= |
| Authentication Error | The specified user was not found or the login credentials didn’t match. |
| Authentication Error | Invalid user_key. |
| Authentication Error | Account Suspended. |
| Not Found | No records were found with the given parameters. |
The above list is not a complete reference. Consult each API method page for information on method-specific error responses.