Get Meals
URL: | [Data Provider Base URL]/openmeal/v2/meals.json |
HTTP Method: | GET |
Parameters: |
|
Formats: | JSON |
Response
All available meals corresponding to the methods parameter are returned. The basic structure of the response is as follows...
Property | Type | Description | Required? |
---|---|---|---|
distributors | Array of Distributor Objects | A list of all the distributors for the meal (if the same meal is served in several schools for example. | Yes |
meals | Array of Meal objects | The meals served within the set dates | Yes |
Distributor
Same as the Distributor object returned by the List Distributors method.
Meal
The Meal object describes a whole meal, such as a lunch or a dinner, including all alternative dishes.
Property | Type | Description | Required? |
---|---|---|---|
date | String | The data of the meal in ISO 8601 format, for example 2015-05-20T00:00:00 | Yes |
lang | String | The 2-letter ISO 639 alpha-2 language code describing the language used in all Strings of this object. For example sv for Swedish. | Yes |
name | String | The name of the meal, for example "Lunch" | Yes |
description | String | An optional description of the meal | No |
courses | Array of Course Objects | All the alternative dishes for the meal | Yes |
Course
The Course object describes a specific dish that is part of the Meal.
Property | Type | Description | Required? |
---|---|---|---|
name | String | The name of the course, for example "Swedish Meatballs" | Yes |
description | String | An optional longer description of the course | No |
order | Integer | Used to sort the courses in a prefered order, with lowest order value first | No |
ingredients | String | Describes what ingredients, including allergens, the course contains according to EU regulation 1169/2011. Not meant to be used as a recipe. | No |
allergens | Array of Strings | Describes the allergens of the course by name. | No |
nutrients | Array of Objects | Describing the ingredients of the course one by one. If a nutrients array exists the information listed in it must correspond to what is in the text property, so tht only the text property can be used. | No |
nutrients > name | String | The name of the nutrient | Yes, if nutrients are specified |
nutrients > amount | String | The amount of the nutrient in a standard serving of the course | Yes, if nutrients are specified |
nutrients > unit | String | The unit the amount is measured in | Yes, if nutrients are specified |
Example
GET http://openmeal.foodindustries.inc/openmeal/v2/meals.json?startDate=2015-10-19
{
"data" : [
{
"distributors" : [
{
"name" : "The Local School",
"lang" : "en",
"address" : {
"streetAddress" : "Main Street 42",
"postalCode" : "555 55",
"addressLocality" : "Stockholm",
"addressCountry" : "SE"
},
"url" : "http://thelocalschool.se",
"telephone" : "+46 555 555 555",
"distributorID" : "123456789"
},
...
],
"meals" : [
{
"date" : "2015-05-20T00:00:00",
"lang" : "en",
"name" : "Lunch",
"description" : "Swedish Food Week",
"courses" : [
"name" : "Swedish Meatballs with mashed potatoes",
"order" : 1,
"ingredients" : "Meat, bread crumbs, eggs, milk, potatoes",
"allergens" : ["Egg", "Milk", "Nuts"],
"nutrients" : [
{
"name" : "Energy",
"amount" : "540",
"unit" : "kcal"
},
...
]
]
},
...
]
},
...
]
}