API: deals

Parameters

key

[required] key for access to the API (get/view your key)
format: api key

id

[required] id which was provided by the results of a search call
format: generated key

Return Values

api

Returns details about the API and call

• status: see below Return Status Codes
• api_version: 2.1
• format: json
• api_key: [your api key]

id

Generated key for the restaurant

deals

return of deal(s) with the following structure

• provider: 0 - 75 characters
• provider_url: 0 - 120 characters starting with http://
• headline: 0 - 100 characters
• description: 0 - 255 characters
• disclaimer: 0 - 125 characters
• date_start: yyyy-mm-dd (ISO 8601)
• date_end: yyyy-mm-dd (ISO 8601)
• menu_item_name: 2 - 75 characters
• hours_start: hh:mm (ISO 8601 - 24 hour time)
• hours_end: hh:mm (ISO 8601 - 24 hour time)
• day_mon: 0 | 1 | null
• day_tue: 0 | 1 | null
• day_wed: 0 | 1 | null
• day_thu: 0 | 1 | null
• day_fri: 0 | 1 | null
• day_sat: 0 | 1 | null
• day_sun: 0 | 1 | null
• restaurant_name: 2 - 255 characters
• address_1: 2 - 120 characters
• city_town: 2 - 50 characters
• created_date: yyyy-mm-dd (ISO 8601)

Return Status Codes

200

successful call

204

call resulted in an empty resultset

400

incorrect or missing API key

404

incorrect or missing required parameter

429

call limit exceeded on API key (check your limit)

Sample Response

{ "response": { "api": { "status": 200, "api_version": "2.1", "format": "json", "api_key": "[your_key]" }, "result": { "id": "", "deals": [ { "provider": "", "provider_url": null, "headline": "", "description": "", "disclaimer": "L", "date_start": null, "date_end": null, "menu_item_name": null, "hours_start": "", "hours_end": "", "day_mon": "", "day_tue": "", "day_wed": "", "day_thu": "", "day_fri": "", "day_sat": "", "day_sun": "", "restaurant_name": "", "address_1": "", "city_town": "", "created_date": "" } ] } } }

Notes

• use an ID of 'sample' (no quotes, no other options) for a sample result that doesn't count against your credits.