ADDEDIT BuyerContractHeaders API Version 1

Updated on 2015-4-21
Current Version: Version 1
Deprecated Version: N/A
Requests Allowed: GET/SOAP

 

Summary:

Allows you to add, replace or remove Post/Ping headers from a Buyer Contract.

 

Resource/WSDL Page:

http://<your_domain_here>/api/1/addedit.asmx?op=BuyerContractHeaders


Parameters

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

This api_key will provide you with the ability to export Campaigns for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.

Example Values:

Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

buyer_contract_id
Required
Type: INTEGER
Length (Max/Min): N/A

This is the identifier for a unique buyer contract.

You can obtain the buyer contract ID from your CAKE instance on the buyer contract card.

Example Values: 0 or 1234

delivery_method_type
Required
Type: STRING
Length (Max/Min): N/A

This is the identifier for the delivery method type that you wish to update. You can update the values for either a ping or post delivery method.

Example Values: ping or post

add_edit_option
Required
Type: STRING
Length (Max/Min): N/A

This is the identifier for if you would like to add, replace or remove the header information. You can enter add, replace or remove.

Example Values: add, replace or remove

 

headers

Required

TYPE: STRING

Length (Max/Min): N/A 

These are the headers that you would like to add, replace or remove. 

Example Values: Header1, header2

values
Required
Type: STRING
Length (Max/Min): N/A 

These are the values that you would like to add, replace or remove

Example Values: Value1, Value2

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

**Note if using the replace add_edit_option then the system will replace the first header/value listed on the Buyer Contract.

 

Example Request

GET

http://demo.cakemarketing.com/api/1/addedit.asmx/BuyerContractHeaders?api_key= BEyqzddodKbz0&buyer_contract_id=217&delivery_method_type=post&add_edit_option=add&headers=Header1&values=Value1

 

Sample XML Response:

<success>true</success>

<message>

Buyer Contract (217) Post Header(s) Added Successfully

</message>

<row_count>1</row_count>

</buyer_contract_header_addedit_response>

 

Example Error Messages:

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired.