Select an API to view Documentation: 


This API retrieves all the available special types to be used to narrow your specials search.


/special_types



Name Data Type Required Description
api_key string YES API Key that was given to you at API registration
version string YES Version of the API (Current version = 2)

Sample Request

http://www.findmespecials.com/api/special_types?api_key=YOUR_KEY&version=2



 

Response Values

Response Node Data Type Number of times occuring Description
response Node 1 Response body
response_header Node 1 Response summary.
Attributes include:
status:Response Status.
special_type_count:Total number of special_types available in result.
special_types Node 1 Container for special_types
special_type Node 0..special_type_count Container for each special_event_type
Attributes include:
id:ID for special_type.
special_type.name string 1 for each special_type Name of special_type
special_type.description string 1 for each special_type Description of special_type

 

Sample Response

      
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <response_header status="OK" special_types_count="2"/>
  <special_types>
    <special_type id="97">
      <name>Breakfast/Brunch</name>
      <description>Breakfast/Brunch</description>
    </special_type>
    <special_type id="128">
      <name>Clothing/Fashion</name>
      <description></description>
    </special_type>
  </special_types>
</response>