Skip to content

Commit b9b470a

Browse files
committed
Add docs for new SLS API endpoint
1 parent b901544 commit b9b470a

File tree

1 file changed

+134
-1
lines changed

1 file changed

+134
-1
lines changed

source/includes/_mensa_api.md

Lines changed: 134 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ curl "https://sls.api.stw-on.de/v1/location/101/menu/2018-02-26?time=evening"
201201
### URL Parameter
202202

203203
Parameter | Beschreibung
204-
----------| -----------------------------------------------------------------
204+
--------- | -----------------------------------------------------------------
205205
`id` | Die ID der Mensa. Siehe [Liste aller Mensen](#liste-aller-mensen)
206206
`isoDate` | Datum nach ISO 8601 (z.B. `2020-06-18`)
207207

@@ -210,3 +210,136 @@ Parameter | Beschreibung
210210
Parameter | Beschreibung | Standard
211211
----------------- | -------------------------------------------------- | ---------
212212
`time` (optional) | Tageszeit (`morning`, `noon`, `evening` oder `all` | `all`
213+
214+
215+
## Mehrere Tagesmenüs
216+
217+
> Beispiel:
218+
219+
```shell
220+
curl "https://sls.api.stw-on.de/v1/location/101/menu/2018-02-26/2018-02-28?time=evening"
221+
```
222+
223+
```json-doc
224+
{
225+
"announcements": [
226+
{
227+
"id": 775,
228+
"start_date": "2018-01-22",
229+
"end_date": "2018-03-10",
230+
"text": "Beginn 2. Bauphase – Mensa 1 ab 22. Januar geschlossen",
231+
"closed": true, // Gibt an, ob die Mensa in der Zeit geschlossen hat
232+
"time": "all"
233+
}
234+
],
235+
"meals": [
236+
{
237+
"id": 3028,
238+
"date": "2018-02-26",
239+
"name": "Kartoffeln",
240+
"price": { // Preise in EUR
241+
"student": "0.50",
242+
"employee": "0.70",
243+
"guest": "0.70"
244+
},
245+
"location": {
246+
"id": 101,
247+
"name": "Mensa BS TU 1",
248+
"address": {
249+
"line1": "Mensa 1 TU Braunschweig",
250+
"line2": null,
251+
"street": "Katharinenstraße 1",
252+
"zip": "38106",
253+
"city": "Braunschweig"
254+
}
255+
},
256+
"time": "evening",
257+
"lane": {
258+
"id": 310,
259+
"name": "Beilage"
260+
},
261+
"tags": {
262+
"categories": [ // Allgemeine Kategorien
263+
{
264+
"id": "VEGA",
265+
"name": "Vegan"
266+
}
267+
],
268+
"allergens": [ // Enthaltene Allergene
269+
270+
],
271+
"additives": [ // Enthaltene Zusatzstoffe
272+
273+
]
274+
},
275+
"special_tags": [ // Spezialangebote
276+
277+
]
278+
},
279+
{
280+
"id": 3029,
281+
"date": "2018-02-27",
282+
"name": "Spaghetti",
283+
"price": {
284+
"student": "0.50",
285+
"employee": "0.70",
286+
"guest": "0.70"
287+
},
288+
"location": {
289+
"id": 101,
290+
"name": "Mensa BS TU 1",
291+
"address": {
292+
"line1": "Mensa 1 TU Braunschweig",
293+
"line2": null,
294+
"street": "Katharinenstraße 1",
295+
"zip": "38106",
296+
"city": "Braunschweig"
297+
}
298+
},
299+
"time": "evening",
300+
"lane": {
301+
"id": 310,
302+
"name": "Beilage"
303+
},
304+
"tags": {
305+
"categories": [
306+
{
307+
"id": "VEGA",
308+
"name": "Vegan"
309+
}
310+
],
311+
"allergens": [
312+
{
313+
"id": "GL1",
314+
"name": "GL namentlich Weizen"
315+
}
316+
],
317+
"additives": [
318+
319+
]
320+
},
321+
"special_tags": [
322+
323+
]
324+
}
325+
]
326+
}
327+
```
328+
329+
### HTTP
330+
331+
`GET https://sls.api.stw-on.de/v1/location/<id>/menu/<startIsoDate>/<endIsoDate>`
332+
333+
### URL Parameter
334+
335+
Parameter | Beschreibung
336+
-------------- | -----------------------------------------------------------------
337+
`id` | Die ID der Mensa. Siehe [Liste aller Mensen](#liste-aller-mensen)
338+
`startIsoDate` | Startdatum (von) nach ISO 8601 (z.B. `2020-06-18`)
339+
`endIsoDate` | Enddatum (bis) nach ISO 8601 (z.B. `2020-06-18`)
340+
341+
### Query Parameter
342+
343+
Parameter | Beschreibung | Standard
344+
----------------- | -------------------------------------------------- | ---------
345+
`time` (optional) | Tageszeit (`morning`, `noon`, `evening` oder `all` | `all`

0 commit comments

Comments
 (0)