getContactDetails

Request Method: GET

Description: Retrieves the details of a contact from the database in XML

URL: https://api.iovox.com:444/Contacts?v=3&method=getContactDetails

The following parameters can be sent in the querystring

ParameterDescriptionDefault ValueData TypeMandatory
vAPI version to use
INTEGERYES
contact_idReturns the Contact with the specified Contact ID
STRINGYES
pageThe page number to return. Use together with limit to achieve paginated results1INTEGERNO
limitDetermines how many results to return. Use together with page to achieve paginated results. Maximum here is 2000020000INTEGERNO
outputSpecifying XML or JSON returns data in XML or JSON format XMLSTRINGNO

Result

Error Result

HTTP CodeError StringResolution
400API Version EmptyAdd a value for the v parameter in the query string
400API Version InvalidCorrect v parameter
400Request Method must be GET. x attemptedSwitch request method x to GET
400Page Number not an integerRemove non-numerics from page
400Limit not an integerRemove non-numerics from limit
400Limit must be between 1 and 20000Correct the limit parameter
400Output Type InvalidCorrect output parameter
500Internal Server ErrorRetry later

Success Result

<?xml version="1.0" encoding="utf-8"?>
<response>
     <current_page>1<current_page>
     <total_pages>4<total_pages>
     <total_results>100<total_results>
     <results>
         <result>
             <contact_id>24</contact_id>
             <first_name>James</first_name>
             <last_name>Smith</last_name>
             <display_name>James Smith</display_name>
             <email>james@iovox.com</email>
             <email_2>james.smith@iovox.com</email_2>
             <company>iovox</company>
             <title>Advertising</title>
             <business_phone>44755555555</business_phone>
             <business_fax>447755555555</business_fax>
             <work_address_1>153 Westbourne Grove</work_address_1>
             <work_address_2>W11</work_address_2>
             <work_city>London</work_city>
             <work_postcode>W11 </work_postcode>
             <work_country>United Kingdom</work_country>
             <home_phone>44</home_phone>
             <mobile_phone>44</mobile_phone>
             <home_address_1>153 Westbourne Grove</home_address_1>
             <home_address_2>W11</home_address_2>
             <home_city>London</home_city>
             <home_postcode>W11</home_postcode>
             <home_country>United Kingdom</home_country>
             <notes>This is a contact note</notes>
         </result>
     </results>
 </response>