Documentation

Common XML, JSON and SOAP Error Codes


The error codes below are applicable to all methods:-

Name Description
method_not_subscribed You are not subscribed to the specified method.
missing_(param) The named mandatory parameter is missing. For example:- missing_api_key indicates that the parameter api_key is missing.
invalid_(param) The named parameter is in an invalid format. For example:- invalid_api_key indicates that the api_key value is invalid.
expired_javascript_key The javascript_key value, used during client-side request, has expired.
http_referrer_missing When a javascript_key is in use, the http referrer request header was missing, so the domain cannot be authenticated.
client_ip_address_not_allowed When a javascript_key is in use, the IP address permitted to use the key does not match the final user's IP address.
client_domain_not_allowed When not using a JavaScript key, the IP address from which the request has originated does not match any of the permitted IP addresses set the control panel.
unauthorised_ip_address When not using a JavaScript key, the IP address from which the request has originated does not match any of the permitted IP addresses set the control panel.
insufficient_credit You do not have sufficient credit to use this method.
too_many The request returned more records than can be included in the response. More information should be supplied to allow the search to be narrowed.
no_record The request returned no records. We return an error code in preference to the more verbose option of returning an empty result set.
invalid_address The address given in the input parameters is invalid.
failed A general error has occurred. In normal operation you should never see this error; please use our backup facility.
no_database A general error has occurred. In normal operation you should never see this error; please use our backup facility.

Next: Common Response Structures