EXPORT AffiliateReferrals API Version 1

Updated on 2014-03-26
Current Version: Version 1
Deprecated Version: 
Requests Allowed: GET&SOAP
 


Summary:

Returns an array of Affiliate Referrals. The start_at_row property defines how many records would be skipped before showing the first row (could be used for paging) and row_limit will define how many rows are displayed per call.


Resource/WSDL Page:

http://yourdomainhere.com/api/1/export.asmx?op=AffiliateReferrals 


Parameters

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

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

referrer_affiliate_id
Required
Type: INT
Length (Max/Min): NA

Referring Affiliate must exist already 

start_at_row
Required
Type: INT
Length (Max/Min): NA

Must pass at least 0 as value, which means start at the beginning of the data set.

row_limit
Required
Type: INT
Length (Max/Min): NA

Must pass at least 0 as value, which means no limit.  Number of rows returned per page.

 

**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

http://demo.cakemarketing.com/api/1/export.asmx/AffiliateReferrals?api_key=dNJFmId9rI&referrer_affiliate_id=0&start_at_row=1&row_limit=5

Sample XML Response:

<affiliate_referral_export_response>
  <success>true</success>
  <row_count>60</row_count>
  <referrals>
    <referral>
      <referrer_affiliate_id>2037</referrer_affiliate_id>
      <referrer_affiliate_name>404 Capital</referrer_affiliate_name>
      <affiliate_id>2309</affiliate_id>
      <affiliate_name>1 PJ</affiliate_name>
      <flat_fee>true</flat_fee>
      <profit_based>true</profit_based>
      <minimum_threshold>1000.0000</minimum_threshold>
      <payment_amount>50.00</payment_amount>
      <payment_amount_formatted>$50.00</payment_amount_formatted>
      <start_date>2013-02-06T00:00:00</start_date>
      <end_date xsi:nil="true"/>
      <currency>
        <currency_id>1</currency_id>
        <currency_name>US Dollar</currency_name>
        <currency_abbr>USD</currency_abbr>
        <currency_symbol>$</currency_symbol>
      </currency>
    </referral>
    <referral>
      <referrer_affiliate_id>1980</referrer_affiliate_id>
      <referrer_affiliate_name>2011 Media</referrer_affiliate_name>
      <affiliate_id>2309</affiliate_id>
      <affiliate_name>1 PJ</affiliate_name>
      <flat_fee>true</flat_fee>
      <profit_based>true</profit_based>
      <minimum_threshold>0.0000</minimum_threshold>
      <payment_amount>50.00</payment_amount>
      <payment_amount_formatted>$50.00</payment_amount_formatted>
      <start_date>2012-05-07T00:00:00</start_date>
      <end_date xsi:nil="true"/>
      <currency>
        <currency_id>1</currency_id>
        <currency_name>US Dollar</currency_name>
        <currency_abbr>USD</currency_abbr>
        <currency_symbol>$</currency_symbol>
      </currency>
    </referral>
    <referral>
      <referrer_affiliate_id>5708</referrer_affiliate_id>
      <referrer_affiliate_name>101 SSI Affiliate</referrer_affiliate_name>
      <affiliate_id>5406</affiliate_id>
      <affiliate_name>123 Main St Marketing</affiliate_name>
      <flat_fee>false</flat_fee>
      <profit_based>false</profit_based>
      <minimum_threshold>50.0000</minimum_threshold>
      <payment_amount>5.00</payment_amount>
      <payment_amount_formatted>5.00 %</payment_amount_formatted>
      <start_date>2012-10-01T00:00:00</start_date>
      <end_date xsi:nil="true"/>
      <currency>
        <currency_id>1</currency_id>
        <currency_name>US Dollar</currency_name>
        <currency_abbr>USD</currency_abbr>
        <currency_symbol>$</currency_symbol>
      </currency>
    </referral>
    <referral>
      <referrer_affiliate_id>5833</referrer_affiliate_id>
      <referrer_affiliate_name>z-Jena Training Affiliate</referrer_affiliate_name>
      <affiliate_id>19</affiliate_id>
      <affiliate_name>143 LLC</affiliate_name>
      <flat_fee>false</flat_fee>
      <profit_based>true</profit_based>
      <minimum_threshold>100.0000</minimum_threshold>
      <payment_amount>8.00</payment_amount>
      <payment_amount_formatted>8.00 %</payment_amount_formatted>
      <start_date>2013-02-07T00:00:00</start_date>
      <end_date xsi:nil="true"/>
      <currency>
        <currency_id>1</currency_id>
        <currency_name>US Dollar</currency_name>
        <currency_abbr>USD</currency_abbr>
        <currency_symbol>$</currency_symbol>
      </currency>
    </referral>
    <referral>
      <referrer_affiliate_id>1222</referrer_affiliate_id>
      <referrer_affiliate_name>1 G</referrer_affiliate_name>
      <affiliate_id>1988</affiliate_id>
      <affiliate_name>2 Lead Media</affiliate_name>
      <flat_fee>false</flat_fee>
      <profit_based>false</profit_based>
      <minimum_threshold>100.0000</minimum_threshold>
      <payment_amount>5.00</payment_amount>
      <payment_amount_formatted>5.00 %</payment_amount_formatted>
      <start_date>2012-09-01T00:00:00</start_date>
      <end_date xsi:nil="true"/>
      <currency>
        <currency_id>1</currency_id>
        <currency_name>US Dollar</currency_name>
        <currency_abbr>USD</currency_abbr>
        <currency_symbol>$</currency_symbol>
      </currency>
    </referral>
  </referrals>
</affiliate_referral_export_response>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

Invalid Affiliate ID

Affiliate does not exist