Error handling

For ACTIVE Net System API requests, the response contains two types of status codes:

HTTP status codes

ACTIVE Net System APIs use the following standard HTTP status codes:

Code Name Description
200 OK The request is successful.
400 Bad Request The server cannot process the request due to a client error (e.g. malformed request syntax, invalid request message framing, or deceptive request routing).
401 Unauthorized The request has not been processed due to invalid authentication credentials for the target resource.
403 Forbidden The server understood the request but refused to authorize it.
404 Not Found The server did not find a current representation for the target resource or is unwilling to disclose that one exists.
500 Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.
503 Service Unavailable The server is currently unable to handle the request due to a temporary overload or scheduled maintenance.

For more information about HTTP status codes, refer to https://tools.ietf.org/html/rfc2616#section-10.4.

ACTIVE Net defined response codes

ACTIVE Net System APIs may respond with ACTIVE Net defined response codes and response messages. Even if an HTTP 200 OK response is received, it is still necessary to check the response_code and response_message.

 

If the request was successful, then the following response_code and response_message are returned in the response body:

 

{

    "headers": {

        "response_code": "0000",

        "response_message": "Successful"

    },

    "body": []

}

 

 

If an error has occurred, then the response_code and response_message contain information about the error, and the body object is empty.

 

Example: if the request contained an invalid request parameter, then the following response_code and response_message are returned:

 

{

    "headers": {

        "response_code": "0016",

        "response_message": "Unknown Parameters."

    },

    "body": []

}

 

Detailed information for each error code is shown in the table below:

Code Name Description
0000 Successful  
0001 No results found No matching results.
0005 No license Your ACTIVE Net System API license is not enabled. To enable your API license, please contact the ACTIVE Net support team (activenetsupport@activenetwork.com).
0013 Invalid API request The API request URL is incorrectly formatted. For example, api_key is missing. Refer to Retrieving data from ACTIVE Net.
0015

Invalid pagination parameter

Check pagination parameters for errors. Refer to Pagination and sorting.
0016 Unknown parameter The parameters provided were not recognized. Check parameters for errors and verify if the parameters are supported by the API. Refer to the Request Parameters section for each individual API.
0017

Parameter type mismatch

Verify if the parameter type is correct. Refer to the Request Parameters chapter for each individual API.
0018

Invalid order by parameter

Verify if the order by value is supported by the API. Refer to the Request Parameters section for each individual API.
9999 Unknown error An unknown error occurred. Ensure your network is connected and send the API request again.

 

Related topics

Getting Started Guide

Authentication

Retrieving data from ACTIVE Net

Common header parameters

API rate limits

Versioning

Terms of Use