NOTICE: THIS VERSION OF THE API HAS BEEN DEPRECATED. IT WILL CONTINUE TO WORK INDEFINITELY, BUT HAS INCREASED FUNCTIONALITY IN NEWER VERSIONS.
WSDL Page: http://<your_domain_here>/api/3/export.asmx?op=Advertisers
Parameter Summary:
api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}
advertiser_id / INT = Advertiser ID ["0" = ALL Advertisers] {See export.asmx > Advertisers}
advertiser_name / STRING = Freeform Search Term
account_manager_id / INT = Advertiser Manager ID ["0" = ALL Advertiser Managers]
tag_id / STRING = Tag ID ["0" = ALL Tags] {See get.asmx > AffiliateTags}
start_at_row / INT = Starting Row Number [Usually "1", unless doing incremental API Calls]
row_limit / INT = Maximum Rows Returned ["0" = ALL Rows, "100000" = Maximum]
sort_field / STRING = Sort Field ["advertiser_id", "advertiser_name", "date_created"]
sort_descending / BOOL = Sort Descending? ["TRUE", "FALSE"]
Parameter Types:
api_key - ID
advertiser_id - ID
advertiser_name - ID
account_manager_id - ID
tag_id - ID
start_at_row - ID
row_limit - ID
sort_field - ID
sort_descending - ID
Sample GET Call:
http://demo.cakemarketing.com/api/3/export.asmx/Advertisers?api_key=dNJFmId9rI&advertiser_id=2&advertiser_name=&account_manager_id=0&tag_id=0&start_at_row=1&row_limit=1&sort_field=advertiser_id&sort_descending=FALSE
Sample XML Response:
<advertiser_export_response>
<success>true</success>
<row_count>1</row_count>
<advertisers>
<advertiser>
<advertiser_id>2</advertiser_id>
<advertiser_name>Mink Media</advertiser_name>
<account_managers>
<contact>
<contact_id>1158</contact_id>
<contact_name>Mike Walters</contact_name>
</contact>
</account_managers>
<account_status>
<account_status_id>1</account_status_id>
<account_status_name>Active</account_status_name>
</account_status>
<address>
<street_1/>
<street_2/>
<city/>
<state/>
<zip_code/>
<country/>
</address>
<website>http://www.cakemarketing.com</website>
<contacts>
<contact>
<contact_id>1295</contact_id>
<contact_type>
<contact_type_id>1</contact_type_id>
<contact_type_name>Account Manager</contact_type_name>
</contact_type>
<role>
<role_id>7</role_id>
<role_name>Advertiser</role_name>
</role>
<department>
<department_id xsi:nil="true"/>
<department_name/>
</department>
<first_name>John</first_name>
<middle_name/>
<last_name>Doe</last_name>
<email_address>test@cakemarketing.com</email_address>
<title>CMO</title>
<phone_work>555-1212</phone_work>
<phone_cell>555-1212</phone_cell>
<phone_fax/>
<im_service/>
<im_name/>
<include_in_mass_emails>true</include_in_mass_emails>
<notes/>
</contact>
</contacts>
<tags/>
<suppression_lists>
<suppression_list>
<suppression_list_id>35</suppression_list_id>
<suppression_list_name>Suppression List 35</suppression_list_name>
<suppression_list_type>
<suppression_list_type_id>1</suppression_list_type_id>
<suppression_list_type_name>Static Link</suppression_list_type_name>
</suppression_list_type>
<md5_only>false</md5_only>
<date_created>2012-06-22T18:23:21.94</date_created>
<static_link_info>
<list_location>https://affiliates.leadsaccelerize.com/creatives/suppression/sfc.zip</list_location>
</static_link_info>
</suppression_list>
<suppression_list>
<suppression_list_id>70</suppression_list_id>
<suppression_list_name>Suppression List 70</suppression_list_name>
<suppression_list_type>
<suppression_list_type_id>3</suppression_list_type_id>
<suppression_list_type_name>Optizmo</suppression_list_type_name>
</suppression_list_type>
<md5_only>false</md5_only>
<date_created>2012-06-28T16:29:45.437</date_created>
<optizmo_info>
<list_location>https://one.optizmo.net/api?action=add_emails&onid=9863748b822ed1dec82ccff39e517d52&advertiser_id=2&advertiser_name=Mink+Media&optout_id=70&optout_name=Suppression+List+70&optout_set_md5only=0&ref=qhsmw&check_hash=b2b344bc9a35b0f6869f800477fda888</list_location>
<list_size>0</list_size>
<date_updated xsi:nil="true"/>
</optizmo_info>
</suppression_list>
</suppression_lists>
<blacklists/>
<billing_cycle>
<billing_cycle_id>3</billing_cycle_id>
<billing_cycle_name>Monthly</billing_cycle_name>
</billing_cycle>
<quickbooks_id xsi:nil="true"/>
<online_signup>false</online_signup>
<signup_ip_address/>
<api_key>rKm71EV06m0</api_key>
<date_created>2011-07-08T00:00:00</date_created>
<notes/>
</advertiser>
</advertisers>
</advertiser_export_response>