Skip to content

Commit dfc0909

Browse files
committed
Update SLS docs
1 parent 368a150 commit dfc0909

File tree

1 file changed

+127
-6
lines changed

1 file changed

+127
-6
lines changed

source/includes/_mensa_api.md

Lines changed: 127 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ curl "https://sls.api.stw-on.de/v1/location"
7676
> Beispiel:
7777
7878
```shell
79-
curl "https://sls.api.stw-on.de/v1/location/101"
79+
curl "https://sls.api.stw-on.de/v1/locations/101"
8080
```
8181

8282
```json-doc
@@ -118,7 +118,7 @@ curl "https://sls.api.stw-on.de/v1/location/101"
118118

119119
### HTTP
120120

121-
`GET https://sls.api.stw-on.de/v1/location/<id>`
121+
`GET https://sls.api.stw-on.de/v1/locations/<id>`
122122

123123
### URL Parameter
124124

@@ -132,7 +132,7 @@ Parameter | Beschreibung
132132
> Beispiel:
133133
134134
```shell
135-
curl "https://sls.api.stw-on.de/v1/location/101/menu/2018-02-26?time=evening"
135+
curl "https://sls.api.stw-on.de/v1/locations/101/menu/2018-02-26?time=evening"
136136
```
137137

138138
```json-doc
@@ -245,7 +245,7 @@ curl "https://sls.api.stw-on.de/v1/location/101/menu/2018-02-26?time=evening"
245245

246246
### HTTP
247247

248-
`GET https://sls.api.stw-on.de/v1/location/<id>/menu/<isoDate>`
248+
`GET https://sls.api.stw-on.de/v1/locations/<id>/menu/<isoDate>`
249249

250250
### URL Parameter
251251

@@ -266,7 +266,7 @@ Parameter | Beschreibung | Standar
266266
> Beispiel:
267267
268268
```shell
269-
curl "https://sls.api.stw-on.de/v1/location/101/menu/2018-02-26/2018-02-28?time=evening"
269+
curl "https://sls.api.stw-on.de/v1/locations/101/menu/2018-02-26/2018-02-28?time=evening"
270270
```
271271

272272
```json-doc
@@ -379,7 +379,7 @@ curl "https://sls.api.stw-on.de/v1/location/101/menu/2018-02-26/2018-02-28?time=
379379

380380
### HTTP
381381

382-
`GET https://sls.api.stw-on.de/v1/location/<id>/menu/<startIsoDate>/<endIsoDate>`
382+
`GET https://sls.api.stw-on.de/v1/locations/<id>/menu/<startIsoDate>/<endIsoDate>`
383383

384384
### URL Parameter
385385

@@ -398,3 +398,124 @@ Parameter | Beschreibung
398398
Parameter | Beschreibung | Standard
399399
----------------- | -------------------------------------------------- | ---------
400400
`time` (optional) | Tageszeit (`morning`, `noon`, `evening` oder `all` | `all`
401+
402+
403+
## Alle Tagesmenüs
404+
405+
> Beispiel:
406+
407+
```shell
408+
curl "https://sls.api.stw-on.de/v1/meals"
409+
```
410+
411+
```json-doc
412+
{
413+
"announcements": [
414+
{
415+
"id": 775,
416+
"start_date": "2018-01-22",
417+
"end_date": "2018-03-10",
418+
"text": "Beginn 2. Bauphase – Mensa 1 ab 22. Januar geschlossen",
419+
"closed": true, // Gibt an, ob die Mensa in der Zeit geschlossen hat
420+
"time": "all"
421+
}
422+
],
423+
"meals": [
424+
{
425+
"id": 3028,
426+
"date": "2018-02-26",
427+
"name": "Kartoffeln",
428+
"price": { // Preise in EUR
429+
"student": "0.50",
430+
"employee": "0.70",
431+
"guest": "0.70"
432+
},
433+
"location": {
434+
"id": 101,
435+
"name": "Mensa BS TU 1",
436+
"address": {
437+
"line1": "Mensa 1 TU Braunschweig",
438+
"line2": null,
439+
"street": "Katharinenstraße 1",
440+
"zip": "38106",
441+
"city": "Braunschweig"
442+
},
443+
"opening_hours": [...]
444+
},
445+
"time": "evening",
446+
"lane": {
447+
"id": 310,
448+
"name": "Beilage"
449+
},
450+
"tags": {
451+
"categories": [ // Allgemeine Kategorien
452+
{
453+
"id": "VEGA",
454+
"name": "Vegan"
455+
}
456+
],
457+
"allergens": [ // Enthaltene Allergene
458+
459+
],
460+
"additives": [ // Enthaltene Zusatzstoffe
461+
462+
],
463+
"special": [ // Sonderkennzeichnungen
464+
465+
]
466+
}
467+
},
468+
{
469+
"id": 3029,
470+
"date": "2018-02-27",
471+
"name": "Spaghetti",
472+
"price": {
473+
"student": "0.50",
474+
"employee": "0.70",
475+
"guest": "0.70"
476+
},
477+
"location": {
478+
"id": 101,
479+
"name": "Mensa BS TU 1",
480+
"address": {
481+
"line1": "Mensa 1 TU Braunschweig",
482+
"line2": null,
483+
"street": "Katharinenstraße 1",
484+
"zip": "38106",
485+
"city": "Braunschweig"
486+
},
487+
"opening_hours": [...]
488+
},
489+
"time": "evening",
490+
"lane": {
491+
"id": 310,
492+
"name": "Beilage"
493+
},
494+
"tags": {
495+
"categories": [
496+
{
497+
"id": "VEGA",
498+
"name": "Vegan"
499+
}
500+
],
501+
"allergens": [
502+
{
503+
"id": "GL1",
504+
"name": "GL namentlich Weizen"
505+
}
506+
],
507+
"additives": [
508+
509+
],
510+
"special": [ // Sonderkennzeichnungen
511+
512+
]
513+
}
514+
}
515+
]
516+
}
517+
```
518+
519+
### HTTP
520+
521+
`GET https://sls.api.stw-on.de/v1/meals`

0 commit comments

Comments
 (0)