Submit a Ticket My Tickets
Welcome
Login  Sign up

ADMIN POSTINGDOC API VERSION 1

WSDL Page:  http://<your_domain_here>/api/1/doc.asmx?op=PostingDoc

 

Parameter Summary:

api_key / STRING = Admin API Key 

vertical_id / INT (short) = Vertical ID {See get.asmx > Verticals}

offer_id / INT = Offer ID {See get.asmx > Offers}

campaign_id / INT = Campaign ID {See get.asmx > Campaigns}

post_type / STRING = Posting Type ["server_post", "browser_http_post", "browser_ajax_post"]

 

Parameter Types:

api_key - ID

vertical_id - ID

offer_id - ID

campaign_id - ID

post_type - ID

 

Sample GET Call:

http://demo.cakemarketing.com/api/1/doc.asmx/PostingDoc?api_key=dNJFmId9rI&vertical_id=33&offer_id=1000005&campaign_id=4904&post_type=server_post

 

Sample XML Response:

<posting_doc_doc_response>
  <success>true</success>
  <row_count>0</row_count>
  <vertical>
    <vertical_id>33</vertical_id>
    <vertical_name>Survey</vertical_name>
  </vertical>
  <offer>
    <offer_id>1000005</offer_id>
    <offer_name>$1000 BED BATH AND BEYOND-Survey Offer</offer_name>
  </offer>
  <posting_url>http://dtrk.cakemarketing.com/d.ashx</posting_url>
  <offer_description>German Dating Offer</offer_description>
  <fields>
    <field>
      <field_name>ckm_campaign_id</field_name>
      <required>true</required>
      <field_data>
        <data_type_id>3</data_type_id>
        <data_type_name>number</data_type_name>
        <size xsi:nil="true"/>
        <possible_values>4904</possible_values>
      </field_data>
      <description>Assigned by Cake Demo for each campaign</description>
    </field>
    <field>
      <field_name>ckm_key</field_name>
      <required>true</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size xsi:nil="true"/>
        <possible_values>m0q4AafEaS3YdZWTSvIGA</possible_values>
      </field_data>
      <description>Password assigned by Cake Demo for each campaign</description>
    </field>
    <field>
      <field_name>ckm_subid</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>50</size>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>Optional tracking parameter</description>
    </field>
    <field>
      <field_name>first_name</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>25</size>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>First Name - John</description>
    </field>
    <field>
      <field_name>last_name</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>25</size>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>Last Name</description>
    </field>
    <field>
      <field_name>address</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>40</size>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>Address - 123 Main Street</description>
    </field>
    <field>
      <field_name>city</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>39</size>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>City - Irvine</description>
    </field>
    <field>
      <field_name>state</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>2</size>
        <possible_values>State Abbreviation (e.g. CA, WA)</possible_values>
      </field_data>
      <description>State - CA</description>
    </field>
    <field>
      <field_name>zip_code</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>8</size>
        <possible_values>#####</possible_values>
      </field_data>
      <description>Zip Code - 92620</description>
    </field>
    <field>
      <field_name>email</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>60</size>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>Email Address - [email protected]</description>
    </field>
    <field>
      <field_name>phone_work</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>12</size>
        <possible_values>##########</possible_values>
      </field_data>
      <description>Phone Work - 949-555-8888</description>
    </field>
    <field>
      <field_name>phone_home</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>12</size>
        <possible_values>##########</possible_values>
      </field_data>
      <description>Phone Home - 949-555-8888</description>
    </field>
    <field>
      <field_name>phone</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>12</size>
        <possible_values>##########</possible_values>
      </field_data>
      <description>Phone - 949-555-8888</description>
    </field>
    <field>
      <field_name>best_time</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>4</data_type_id>
        <data_type_name>list</data_type_name>
        <size>1</size>
        <possible_values>M = Morning, A = Afternoon, E = Evening</possible_values>
      </field_data>
      <description>Best Time To Call</description>
    </field>
    <field>
      <field_name>ip_address</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>15</size>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>IP Address</description>
    </field>
    <field>
      <field_name>country</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size>2</size>
        <possible_values>Country Abbreviation (e.g. US, MX)</possible_values>
      </field_data>
      <description>Country - not required</description>
    </field>
    <field>
      <field_name>opt_in</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>5</data_type_id>
        <data_type_name>bool</data_type_name>
        <size xsi:nil="true"/>
        <possible_values>[0 = No, 1 = Yes]</possible_values>
      </field_data>
      <description>Email Opt In - 1</description>
    </field>
    <field>
      <field_name>gender</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>2</data_type_id>
        <data_type_name>date</data_type_name>
        <size xsi:nil="true"/>
        <possible_values>[date]</possible_values>
      </field_data>
      <description>Gender</description>
    </field>
    <field>
      <field_name>ethnicity</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>4</data_type_id>
        <data_type_name>list</data_type_name>
        <size>25</size>
        <possible_values>Black, White, Yellow, Red</possible_values>
      </field_data>
      <description>Ethnicity</description>
    </field>
    <field>
      <field_name>age</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>4</data_type_id>
        <data_type_name>list</data_type_name>
        <size>2</size>
        <possible_values/>
      </field_data>
      <description>Age</description>
    </field>
    <field>
      <field_name>country</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>4</data_type_id>
        <data_type_name>list</data_type_name>
        <size xsi:nil="true"/>
        <possible_values>US, UK</possible_values>
      </field_data>
      <description>Country</description>
    </field>
    <field>
      <field_name>employed</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>4</data_type_id>
        <data_type_name>list</data_type_name>
        <size>3</size>
        <possible_values>Yes, No, Maybe SO</possible_values>
      </field_data>
      <description>Employed</description>
    </field>
    <field>
      <field_name>TEST</field_name>
      <required>false</required>
      <field_data>
        <data_type_id>1</data_type_id>
        <data_type_name>string</data_type_name>
        <size xsi:nil="true"/>
        <possible_values>[text]</possible_values>
      </field_data>
      <description>TEST</description>
    </field>
  </fields>
</posting_doc_doc_response>

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.