GET OfferStatuses API

Updated on 2014-05-21
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

Summary:

Returns an array of offer statuses.

Resource/WSDL Page:

http://<your_domain_here>/api/1/get.asmx?op=OfferStatuses

Parameters

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

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

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

 **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/get.asmx/OfferStatuses?api_key=dNJFmId9rI

 

Sample XML Response:

<offer_statuses_response>
  <success>true</success>
  <row_count>4</row_count>
  <offer_statuses>
    <offer_status>
      <offer_status_id>3</offer_status_id>
      <offer_status_name>Apply To Run</offer_status_name>
    </offer_status>
    <offer_status>
      <offer_status_id>4</offer_status_id>
      <offer_status_name>Inactive</offer_status_name>
    </offer_status>
    <offer_status>
      <offer_status_id>2</offer_status_id>
      <offer_status_name>Private</offer_status_name>
    </offer_status>
    <offer_status>
      <offer_status_id>1</offer_status_id>
      <offer_status_name>Public</offer_status_name>
    </offer_status>
  </offer_statuses>
</offer_statuses_response>

Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired