ADDEDIT Vertical API
Updated on 2014-05-01
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP
Summary:
Allows you to create or update Vertical in CAKE.
Resource/WSDL Page:
http://<your_domain_here>/api/1/addedit.asmx?op=Vertical
Parameters
api_key | Must be a valid API Key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
vertical_id | 0 to create, > 0 to edit Example Values: |
vertical_name | Required on creation, NULL or empty to skip on edit Example Values: Automotive, Mortgage |
vertical_category_id | Required on creation, 0 to skip on edit Example Values: 0 |
notes | NULL sets it as NULL on edit, empty skips on edit Example Values: |
**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 | https://demo-new.cakemarketing.com/api/1/addedit.asmx/Vertical?api_key=3YmDJeT3VHTFhDqAjr2OlQ&vertical_id=0&vertical_name=Vertical+&vertical_category_id=3¬es=notes |
Sample XML Response:
<vertical_addedit_response>
<success>true</success>
<message>Vertical 655 Created</message>
<vertical_id>655</vertical_id>
</vertical_addedit_response>
Example Error Messages:
Error Message | Likely Cause | ||||
Invalid API Key | API Key does not exist or is expired | ||||
Invalid Vertical Name | vertical_name is NULL or empty or exceeds 50 characters | ||||
Invalid Vertical Category | vertical_category_id does not correspond to a vertical category in the system | ||||
Invalid Vertical ID | vertical_id does not correspond to an existing vertical |