ADDEDIT BuyerContractFilter API V1
Updated on 2015-10-07
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP
Summary:
Returns "Buyer Contract ### Filter Added" or "Buyer Contract ### Filter Updated"
Resource/WSDL Page:
http://<your_domain_here>/api/1/addedit.asmx?op=BuyerContractFilter
Parameters
api_key Required Type: STRING Max Length: 50 Char. | Must be a valid API key (existing and Not expired) Example Values: Fo35NRAqvFLXoZxqB4aVMhh |
buyer_contract_id Required Type: INTEGER Max Length: N/A | Buyer Contract’s CAKE entity ID. Obtained via EXPORT BuyerContracts API Pass 0 to create a new Buyer Contract. Passing a value greater than 0 will edit the Buyer Contract with that ID. |
filter_type_id Required Type: INTEGER Max Length: N/A | Identifies the filter type you’d like to use to build your filter. For filter types, see: GET FilterTypes API |
filter_id Required Type: INTEGER Max Length: N/A | Identifies the filter you’d like to edit. To get filter ID’s for editing, see: EXPORT BuyerContracts API Pass 0 to create a new filter |
filter_value Required Type: STRING Max Length: N/A | This field allows you to fill in the values you’d like to match the filter against. For instance, if the filter is Marital Status Equals, the filter values could be “Single|Married” |
add_edit_option Required Type: ENUM Max Length: N/A | This states what kind of modification is happening to the filter. Example Values: add, remove, replace |
**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 |
Sample XML Response:
<?xml version=”1.0”encoding=”utf-8”?>
<buyer_contract_delivery_schedule_addedit_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/">
<success>true</success>
<message>Buyer Contract (1498) Delivery Schedule Added</message>
</buyer_contract_delivery_schedule_addedit_response>
Example Error Messages:
Error Message | Likely Cause |
Invalid API Key | API Key does not exist or is expired |
Invalid Buyer Contract ID | buyer_contract_id is <0 or is >0, but doesn’t match an existing employee contact in CAKE. |
Invalid Filter ID | The filter ID you are trying to edit does not exist. |
Invalid Filter Type ID | The filter type ID you are trying to use does not exist. |
Invalid Filter Value | The string contains invalid characters. |