WSDL Page:  http://your-admin-domain-here.com/api/1/export.asmx?op=Schedules


Parameter Summary:

api_key / STRING = Admin API Key {Found in Setup maintab > Permissions subtab > API Keys}

start_date / DATE = Schedule Start Date [MM/DD/YYYY]

end_date / DATE = Schedule End Date [MM/DD/YYYY]

vertical_id / INT (short) = Vertical ID ["0" = ALL Verticals] {See GET Verticals}

priority_only / BOOL = Return Priority Buyer Contracts Only ["TRUE", "FALSE"]

active_only / BOOL = Return (Active Buyers AND Active Buyer Contracts) with (Credit OR Credit Limit) ["TRUE", "FALSE"]


Parameter Types:

api_key - ID

start_date - ID

end_date - ID

vertical_id - ID

priority_only - ID

active_only - ID


Sample GET Call:

http://demo.cakemarketing.com/api/1/export.asmx/Schedules?api_key=dNJFmId9rI&start_date=01/01/2013&end_date=01/02/2013&vertical_id=1&priority_only=FALSE&active_only=FALSE

 

Sample XML Response:

<schedule_export_response>
  <success>true</success>
  <row_count>3</row_count>
  <schedules>
    <schedule>
      <buyer>
        <buyer_id>758</buyer_id>
        <buyer_name>758 East Group</buyer_name>
        <account_status>
          <account_status_id>1</account_status_id>
          <account_status_name>Active</account_status_name>
        </account_status>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <credit_limit>0.0000</credit_limit>
        <credit_used>0.0000</credit_used>
        <prepaid_amount>10.0000</prepaid_amount>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>947</buyer_contract_id>
        <buyer_contract_name>Bug Test</buyer_contract_name>
        <account_status>
          <account_status_id>1</account_status_id>
          <account_status_name>Active</account_status_name>
        </account_status>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <prepaid_amount xsi:nil="true"/>
        <rank xsi:nil="true"/>
      </buyer_contract>
      <vertical>
        <vertical_id>1</vertical_id>
        <vertical_name>Fast Food</vertical_name>
      </vertical>
      <schedule_type>
        <schedule_type_id>1</schedule_type_id>
        <schedule_type_name>Exclusive</schedule_type_name>
      </schedule_type>
      <default_price>10.0000</default_price>
      <date_open>2013-01-01T00:00:00</date_open>
      <date_closed>2013-01-01T23:59:00</date_closed>
      <sold>0</sold>
      <cap>50</cap>
      <errors>0</errors>
      <ping>true</ping>
      <active>true</active>
      <priority>false</priority>
      <sweeper>false</sweeper>
      <cherry_picked>false</cherry_picked>
    </schedule>
    <schedule>
      <buyer>
        <buyer_id>758</buyer_id>
        <buyer_name>758 East Group</buyer_name>
        <account_status>
          <account_status_id>1</account_status_id>
          <account_status_name>Active</account_status_name>
        </account_status>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <credit_limit>0.0000</credit_limit>
        <credit_used>0.0000</credit_used>
        <prepaid_amount>10.0000</prepaid_amount>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>492</buyer_contract_id>
        <buyer_contract_name>Buyer Contract 492</buyer_contract_name>
        <account_status>
          <account_status_id>1</account_status_id>
          <account_status_name>Active</account_status_name>
        </account_status>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <prepaid_amount>0.0000</prepaid_amount>
        <rank xsi:nil="true"/>
      </buyer_contract>
      <vertical>
        <vertical_id>1</vertical_id>
        <vertical_name>Fast Food</vertical_name>
      </vertical>
      <schedule_type>
        <schedule_type_id>1</schedule_type_id>
        <schedule_type_name>Exclusive</schedule_type_name>
      </schedule_type>
      <default_price>10.0000</default_price>
      <date_open>2013-01-01T00:00:00</date_open>
      <date_closed>2013-01-01T23:59:00</date_closed>
      <sold>0</sold>
      <cap>50</cap>
      <errors>0</errors>
      <ping>false</ping>
      <active>true</active>
      <priority>false</priority>
      <sweeper>false</sweeper>
      <cherry_picked>false</cherry_picked>
    </schedule>
    <schedule>
      <buyer>
        <buyer_id>758</buyer_id>
        <buyer_name>758 East Group</buyer_name>
        <account_status>
          <account_status_id>1</account_status_id>
          <account_status_name>Active</account_status_name>
        </account_status>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <credit_limit>0.0000</credit_limit>
        <credit_used>0.0000</credit_used>
        <prepaid_amount>10.0000</prepaid_amount>
      </buyer>
      <buyer_contract>
        <buyer_contract_id>491</buyer_contract_id>
        <buyer_contract_name>Incorrect Buyer</buyer_contract_name>
        <account_status>
          <account_status_id>1</account_status_id>
          <account_status_name>Active</account_status_name>
        </account_status>
        <currency>
          <currency_id>1</currency_id>
          <currency_symbol>$</currency_symbol>
          <currency_name>US Dollar</currency_name>
          <currency_abbr>USD</currency_abbr>
        </currency>
        <prepaid_amount>9999999.0000</prepaid_amount>
        <rank xsi:nil="true"/>
      </buyer_contract>
      <vertical>
        <vertical_id>1</vertical_id>
        <vertical_name>Fast Food</vertical_name>
      </vertical>
      <schedule_type>
        <schedule_type_id>1</schedule_type_id>
        <schedule_type_name>Exclusive</schedule_type_name>
      </schedule_type>
      <default_price>10.0000</default_price>
      <date_open>2013-01-01T00:00:00</date_open>
      <date_closed>2013-01-01T23:59:00</date_closed>
      <sold>0</sold>
      <cap>50</cap>
      <errors>0</errors>
      <ping>true</ping>
      <active>true</active>
      <priority>false</priority>
      <sweeper>false</sweeper>
      <cherry_picked>false</cherry_picked>
    </schedule>
  </schedules>
</schedule_export_response>