Seil0/TheCitadelofRicks
1
1
Fork 0
Code Issues 3 Pull Requests Releases 14 Wiki Activity

Update page 'API Documentaion'

Jannik 2019-03-12 21:51:07 +01:00
parent 4aace136ea
commit 3ca273f5ae
1 changed files with 104 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

161
API-Documentaion.md

@ -12,17 +12,17 @@ Section that contains the specification for the courses get request. /courses re
"time":1552406531 "time":1552406531
}, },
"courses":[ "courses":[
{ {
"courseName":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=B6B2BF01-9DBA-4017-9245-4BEDF823E0CA&week=0", "courseName":"AI1",
"courseLink":"AI1" "courseLink":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=B6B2BF01-9DBA-4017-9245-4BEDF823E0CA&week=0"
}, },
{ {
"courseName":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=B6DB6637-51BA-47CC-BD69-9CEE1A336333&week=0", "courseName":"AI2",
"courseLink":"AI2" "courseLink":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=B6DB6637-51BA-47CC-BD69-9CEE1A336333&week=0"
}, },
{ {
"courseName":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=DA64F6FE-9DDB-429E-A677-05D0D40CB636&week=0", "courseName":"AI3",
"courseLink":"AI3" "courseLink":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=DA64F6FE-9DDB-429E-A677-05D0D40CB636&week=0"
}, },
... ...
] ]
@ -40,60 +40,52 @@ Each lesson has the following values:
``` json ``` json
{ {
"meta": { "meta":{
"coursename": "AI3" "courseName":"AI4",
"courseLink":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=5D255C23-BC03-4AA0-9F36-DC6767F3E05D&week=0",
"time":1552423212
}, },
"Monday": [ "currentWeek":{
"days":[
{ {
"lessonID": "0.0.0", "timeslots":[
"subject": "Computernetze 1", [
"teacher": "Mayer E.",
"room": "A213",
"remark": ""
},
{ {
"lessonID": "0.1.0", "lessonID":"0.0.0",
"subject": "", "lessonSubject":"Einzeltermin",
"teacher": "", "lessonTeacher":"Dorer",
"room": "", "lessonRoom":"B014",
"remark": "" "lessonRemark":"Kolloquium betriebliche Praxis"
}, }
,
{
"lessonID": "0.2.0",
"subject": "Systemprogramm.",
"teacher": "Mayer E.",
"room": "A213",
"remark": ""
},
...
], ],
"Tuesday": [ [
{ {
"lessonID": "1.0.0", "lessonID":"0.1.0",
"subject": "", "lessonSubject":"Mathematik 4",
"teacher": "", "lessonTeacher":"Decker E.",
"room": "", "lessonRoom":"B121, B206",
"remark": "" "lessonRemark":""
}, },
{ {
"lessonID": "1.1.0", "lessonID":"0.1.1",
"subject": "Softw. Engin. 1", "lessonSubject":"Mathematik 4",
"teacher": "Dorer", "lessonTeacher":"Orb",
"room": "B005", "lessonRoom":"B206, B121",
"remark": "" "lessonRemark":""
}, },
,
{ {
"lessonID": "1.2.0", "lessonID":"0.1.2",
"subject": "Softw. Engin. 1", "lessonSubject":"Einzeltermin",
"teacher": "Dorer", "lessonTeacher":"Dorer",
"room": "B005", "lessonRoom":"B014",
"remark": "" "lessonRemark":"Kolloquium betriebliche Praxis"
}
]
]
}, },
... ...
], ]
... }
} }
``` ```
@ -103,45 +95,58 @@ Section that contains the specification for the /mensamenu get request. /mensame
``` json ``` json
{ {
"Monday": [ "meta":{
{ "mensaName":"Offenburg",
"heading": "Essen 1", "time":1552423539
"meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ",
"additives": ""
}, },
"currentWeek":{
"days":[
{ {
"heading": "Essen 2", "meals":[
"meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ",
"additives": ""
},
{ {
"heading": "Buffet", "day":"Montag 11.03.",
"meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", "heading":"Essen 1",
"additives": "" "parts":[
}, "Gnocchi",
... "Salbeibutter",
"Tomaten-Pilzragout",
"Geriebener Mozzarella",
"Beilagensalat"
], ],
"Tuesday": [ "additives":"enthält Allergene: Ei,Se,Gl,GlW,ML"
{
"heading": "Essen 1",
"meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ",
"additives": ""
}, },
{ {
"heading": "Essen 2", "day":"Montag 11.03.",
"meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", "heading":"Essen 2",
"additives": "" "parts":[
"Geflügel Saté-Spieß",
"Erdnusssauce",
"Butterreis",
"Chinagemüse"
],
"additives":"enthält Allergene: Ei,Er,So,Sn,Fi,Se,Sa,Gl,GlW,GlG,ML"
}, },
{ {
"heading": "Buffet", "day":"Montag 11.03.",
"meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", "heading":"Buffet",
"additives": "" "parts":[
}, "Grill und Salatbar",
... "Asiatisches aus dem Wok",
"Fleisch- und Fischspezialitäten",
"Pasta-, Reis und Kartoffelvariationen",
"Gemüse"
],
"additives":""
}
], ],
... ...
}
]
},
"nextWeek":{
...
}
} }
``` ```