Skip to content

Latest commit

 

History

History
252 lines (221 loc) · 4.34 KB

outlets.md

File metadata and controls

252 lines (221 loc) · 4.34 KB
Raw

Food Services Outlets

GET /foodservices/outlets.{format}

Description

This method returns a list of all outlets and their unique IDs, names and breakfast/lunch/dinner meal service indicators

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1283 Enabled Yes
Service Name foodservices Service ID 269
Information Steward Food Services Data Type Direct DB Connection
Update Frequency Every request (live) Cache Time 0 seconds

Notes

  • Usage won't increase if there is not data returned
  • We cannot modify the data from this method
  • Any value can be null

Sources

Parameters

GET /foodservices/outlets.{format}
Parameter Type Required Description
key filter yes Your API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /foodservices/outlets.{format}

Response

Field Name Type Value Description
outlet_id integer Outlet ID number
outlet_name string Outlet name
has_breakfast boolean If serves breakfast
has_lunch boolean If serves lunch
has_dinner boolean If serves dinner

Any value can be null

Output

JSON

{
  "meta":{
    "requests":139,
    "timestamp":1381961771,
    "status":200,
    "message":"Request successful",
    "method_id":2,
    "version":2.07,
    "method":{
      
    }
  },
  "data":[
    {
      "outlet_id":3,
      "outlet_name":"Bon Appetit",
      "has_breakfast":0,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":9,
      "outlet_name":"Bookends",
      "has_breakfast":1,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":20,
      "outlet_name":"Browser's",
      "has_breakfast":1,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":1,
      "outlet_name":"Brubakers",
      "has_breakfast":0,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":21,
      "outlet_name":"Eye Opener",
      "has_breakfast":1,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":24,
      "outlet_name":"Farm Market",
      "has_breakfast":1,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":6,
      "outlet_name":"Festival Fare",
      "has_breakfast":0,
      "has_lunch":1,
      "has_dinner":0
    },
    {
      "outlet_id":25,
      "outlet_name":"Liquid Assets",
      "has_breakfast":0,
      "has_lunch":1,
      "has_dinner":0
    },
    {
      "outlet_id":5,
      "outlet_name":"Mudie's",
      "has_breakfast":0,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":22,
      "outlet_name":"PAS Lounge",
      "has_breakfast":1,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":23,
      "outlet_name":"Pastry Plus",
      "has_breakfast":1,
      "has_lunch":1,
      "has_dinner":1
    },
    {
      "outlet_id":7,
      "outlet_name":"REVelation",
      "has_breakfast":0,
      "has_lunch":1,
      "has_dinner":1
    }
  ]
}