Export Schedules API Version 1

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

Summary:

Returns an array of buyers and its properties.


Resource/WSDL Page:

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


Parameters

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

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

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

start_date
Required
Type: DATE
Length (Max/Min): NA 

Allowed formats: "YYYY-mm-dd", "mm-dd-YYYY"

Example Values: 2014-04-23, 23-04-2014

end_date
Required
Type: DATE
Length (Max/Min): NA

Allowed formats: "YYYY-mm-dd", "mm-dd-YYYY"

Example Values: 2014-04-23, 23-04-2014

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

Must pass at least >= 0 as value.  Used to filter records matching the value or will return all values if <= 0.

Example Values: 123456

priority_only
Required
Type: BOOL
Length (Max/Min): NA

Return Priority Buyer Contracts Only

Example Values: True

active_only
Required
Type: BOOL
Length (Max/Min): NA

Return (Active Buyers AND Active Buyer Contracts) with (Credit OR Credit Limit)

Example Values: True

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

If passing anything <= 0 the result will include all statuses.

Example Values: 123456

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

If passing anything <= 0 the result will include all buyers.

Example Values: 123456

 

**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/2/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&status_id=0&buyer_id=0 


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>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API key

API key does not exist or is expired