Get Response Dispositions API Version 1

Aldo Lambruschini

Modified on: Mon, 18 Jan, 2021 at 12:46 PM

GET ResponseDispositions API V1

Updated on 2015-06-08
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

Summary:

Returns an array of response dispositions.

Resource/WSDL Page:

http://<your_domain_here>/api/1/get.asmx?op=ResponseDispositions

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and not expired)

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET	https://demo-new.cakemarketing.com/api/1/get.asmx/ResponseDispositions?api_key=3YmDJeT3VHTFhDqAjr2OlQ

Sample XML Response:

<response_dispositions_response><success>true</success><row_count>14</row_count><response_dispositions><response_disposition><response_disposition_id>1</response_disposition_id><response_disposition_name>Communication Error</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>2</response_disposition_id><response_disposition_name>Success</response_disposition_name><is_success>true</is_success></response_disposition><response_disposition><response_disposition_id>4</response_disposition_id><response_disposition_name>Unknown Response</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>6</response_disposition_id><response_disposition_name>Duplicate</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>7</response_disposition_id><response_disposition_name>General Failure</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>8</response_disposition_id><response_disposition_name>Timeout</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>26</response_disposition_id><response_disposition_name>Yes</response_disposition_name><is_success>true</is_success></response_disposition><response_disposition><response_disposition_id>27</response_disposition_id><response_disposition_name>No</response_disposition_name><is_success>true</is_success></response_disposition><response_disposition><response_disposition_id>28</response_disposition_id><response_disposition_name>Works</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>30</response_disposition_id><response_disposition_name>1234567890123456789012345kljkl</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>31</response_disposition_id><response_disposition_name>Chinn</response_disposition_name><is_success>true</is_success></response_disposition><response_disposition><response_disposition_id>32</response_disposition_id><response_disposition_name>TOTALLY WORKED</response_disposition_name><is_success>true</is_success></response_disposition><response_disposition><response_disposition_id>33</response_disposition_id><response_disposition_name>TOTALLY FAILED</response_disposition_name><is_success>false</is_success></response_disposition><response_disposition><response_disposition_id>34</response_disposition_id><response_disposition_name>maybe</response_disposition_name><is_success>true</is_success></response_disposition></response_dispositions></response_dispositions_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired