Submit a Ticket My Tickets
Welcome
Login  Sign up

GET FilterTypes API Version 1

GET FilterTypes API V1

Updated on 2015-06-08
Current Version: Version 2
Deprecated Version: 1
Requests Allowed: GET/POST/SOAP

 

Summary:

This API allows you to get ID’s and details for filter types in the system.

 

Resource/WSDL Page:

http://<your_domain_here>/api/1/get.asmx?op=FilterTypes

 

Parameters

 

api_key
Required
Type: String
Length (Max):  50

As an administrator to your CAKE instance, you can obtain your API key in one of two ways. 1.) From within your instance >> setup tab >> permissions. 2.) Using the GET GetAPIKey

Example Values: dNJFmId9rIZZrs

filter_type_id
Required 
Type: Date
Length (Max/Min):  NA

 

Pass a specific filter type ID to narrow your results. Pass 0 to return all

filter_type_name
Optional
Type: Date
Length (Max/Min):  NA

 

Pass a specific filter name to narrow your results. Pass blank to return all

vertical_id
Optional
Type: INT
Length (Max/Min):  NA

 

 

Obtained via Get Verticals API. Pass 0 to return all

 

Example Values: 7894


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

http://demo.cakemarketing.com/api/1/get.asmx/FilterTypes?api_key=dNJFmId9rI&filter_type_id=0&filter_type_name=&vertical_id=0

 

<filter_types_response><success>true</success><row_count>166</row_count><filter_types><filter_type><filter_type_id>166</filter_type_id><filter_type_name>LTV rt=70</filter_type_name><vertical><vertical_id>707</vertical_id><vertical_name>!!!!!!Insurance</vertical_name></vertical><lead_field>LTV RT</lead_field><operator>Equals</operator></filter_type><filter_type><filter_type_id>77</filter_type_id><filter_type_name>Null</filter_type_name><vertical><vertical_id>227</vertical_id><vertical_name>April Taxes</vertical_name></vertical><lead_field>Hire Month</lead_field><operator>Contains</operator></filter_type>

Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.