Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
217 lines (186 loc) · 3.94 KB

year_week_notes.md

File metadata and controls

217 lines (186 loc) · 3.94 KB

Food Services Menu Notes Filtered by Week

GET /foodservices/{year}/{week}/notes.{format}

Description

This method returns additional notes regarding food served in the week specified

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1297 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 no data returned
  • We cannot modify the data from this method
  • The results are only for the week specified (where the week starts on Monday)
  • Any value can be null

Sources

Parameters

GET /foodservices/{year}/{week}/notes.{format}
Parameter Type Required Description
key filter yes Your API key
year input yes Number representing year
week input yes Number representing week
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /foodservices/{year}/{week}/notes.{format}

Response

Field Name Type Value Description
date object Menu date object
outlet_name string Outlet name as per /foodservices/outlets
outlet_id integer Outlet ID as per /foodservices/outlets
note object Note

Any value can be null

Output

JSON

{
  "meta":{
    "requests":7151,
    "timestamp":1401973635,
    "status":200,
    "message":"Request successful",
    "method_id":1297,
    "method":{
      
    }
  },
  "data":[
    {
      "date":"2014-01-06",
      "outlet_name":"Festival Fare",
      "outlet_id":6,
      "note":"Daily Fish"
    },
    {
      "date":"2014-01-07",
      "outlet_name":"Festival Fare",
      "outlet_id":6,
      "note":"Daily Fish"
    },
    {
      "date":"2014-01-08",
      "outlet_name":"Mudie's",
      "outlet_id":5,
      "note":"\"Welcome Back Dinner\""
    },
    {
      "date":"2014-01-08",
      "outlet_name":"Festival Fare",
      "outlet_id":6,
      "note":"Daily Fish"
    },
    {
      "date":"2014-01-08",
      "outlet_name":"REVelation",
      "outlet_id":7,
      "note":"\"Welcome Back Dinner\"\nLobster Bisque, Apple Blossoms and Ice Cream\nDads Rootbeer, Orangina"
    },
    {
      "date":"2014-01-09",
      "outlet_name":"Festival Fare",
      "outlet_id":6,
      "note":"Daily Fish"
    },
    {
      "date":"2014-01-10",
      "outlet_name":"Festival Fare",
      "outlet_id":6,
      "note":"Daily Fish"
    }
  ]
}