ADDEDIT BuyerContractZipCodeFilter API V1
Updated on 2015-09-28
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET & SOAP
Summary:
Create and edit the zip code distance filter for a specific buyer contract
Resource/WSDL Page:
http://<your_domain_here>/api/1/addedit.asmx?op=BuyerContractZipCodeFilter
Parameters
api_key | You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list. Must be a valid API key (existing and not expired) Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
buyer_contract_id Required Type: INTEGER Max Length: N/A | ID of Buyer Contract you’re editing the filters on. Use Export BuyerContracts API to obtain Pass blank to skip if supplying filter_id below. |
zip_code Required Type: STRING Max Length: 8 | Identifies zipcode to filter against |
zip_code_distance Required Type: INTEGER Max Length: N/A | This identifies the max number of miles from the zip code specified in zip_code that a lead’s zip code can be to be eligible for this Buyer Contract.. |
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
Sample XML Response:
<buyer_contract_zip_code_filter_addedit_response><success>true</success><message>Buyer Contract (1498) Zip Code Filter Added Successfully</message><row_count>0</row_count></buyer_contract_zip_code_filter_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 Zip Code | The zip code you entered is improperly formatted. |
Invalid Distance | The distance value you entered is improperly formatted. |