GET SharedRules API Version 1
Updated on 2016-02-26
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP
Summary:
Returns an array of shared rules
Resource/WSDL Page:
http://<your_domain_here>/api/1/get.asmx?op=SharedRules
Parameters
api_key | Must be a valid API key (existing and not expired) Example Values: RUxep4nIQQmSAFn4JFECgOMdvJLeocp |
**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/get.asmx/SharedRules?api_key=3YmDJeT3VHTFhDqAjr2OlQ |
Sample XML Response:
<shared_rules_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/1/"> <success>true</success> <row_count>6</row_count> <rules> <rule> <rule_id xmlns="API:id_name_store">24</rule_id> <rule_name xmlns="API:id_name_store">Test 2</rule_name> </rule> <rule> <rule_id xmlns="API:id_name_store">34</rule_id> <rule_name xmlns="API:id_name_store">Drew Test Rule</rule_name> </rule> <rule> <rule_id xmlns="API:id_name_store">35</rule_id> <rule_name xmlns="API:id_name_store">Drew Test Rule 2- AU</rule_name> </rule> <rule> <rule_id xmlns="API:id_name_store">36</rule_id> <rule_name xmlns="API:id_name_store">Device</rule_name> </rule> <rule> <rule_id xmlns="API:id_name_store">40</rule_id> <rule_name xmlns="API:id_name_store">Windows</rule_name> </rule> <rule> <rule_id xmlns="API:id_name_store">41</rule_id> <rule_name xmlns="API:id_name_store">CA</rule_name> </rule> </rules> </shared_rules_response>
Example Error Messages:
Error Message | Likely Cause |
Invalid API Key | API key does not exist or is expired |