From 3ca273f5aefb83bcb44f53bbd5321cbf25e5a0db Mon Sep 17 00:00:00 2001 From: Seil0 Date: Tue, 12 Mar 2019 21:51:07 +0100 Subject: [PATCH] Update page 'API Documentaion' --- API-Documentaion.md | 203 +++++++++++++++++++++++--------------------- 1 file changed, 104 insertions(+), 99 deletions(-) diff --git a/API-Documentaion.md b/API-Documentaion.md index e0d3268..cedc670 100644 --- a/API-Documentaion.md +++ b/API-Documentaion.md @@ -12,17 +12,17 @@ Section that contains the specification for the courses get request. /courses re "time":1552406531 }, "courses":[ - { - "courseName":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=B6B2BF01-9DBA-4017-9245-4BEDF823E0CA&week=0", - "courseLink":"AI1" +{ + "courseName":"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", - "courseLink":"AI2" + "courseName":"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", - "courseLink":"AI3" + "courseName":"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 { - "meta": { - "coursename": "AI3" - }, - "Monday": [ - { - "lessonID": "0.0.0", - "subject": "Computernetze 1", - "teacher": "Mayer E.", - "room": "A213", - "remark": "" - }, - { - "lessonID": "0.1.0", - "subject": "", - "teacher": "", - "room": "", - "remark": "" - }, - , - { - "lessonID": "0.2.0", - "subject": "Systemprogramm.", - "teacher": "Mayer E.", - "room": "A213", - "remark": "" - }, - ... - ], - "Tuesday": [ - { - "lessonID": "1.0.0", - "subject": "", - "teacher": "", - "room": "", - "remark": "" - }, - { - "lessonID": "1.1.0", - "subject": "Softw. Engin. 1", - "teacher": "Dorer", - "room": "B005", - "remark": "" - }, - , - { - "lessonID": "1.2.0", - "subject": "Softw. Engin. 1", - "teacher": "Dorer", - "room": "B005", - "remark": "" - }, - ... - ], - ... + "meta":{ + "courseName":"AI4", + "courseLink":"https://www.hs-offenburg.de/index.php?id=6627&class=class&iddV=5D255C23-BC03-4AA0-9F36-DC6767F3E05D&week=0", + "time":1552423212 + }, + "currentWeek":{ + "days":[ + { + "timeslots":[ + [ + { + "lessonID":"0.0.0", + "lessonSubject":"Einzeltermin", + "lessonTeacher":"Dorer", + "lessonRoom":"B014", + "lessonRemark":"Kolloquium betriebliche Praxis" + } + ], + [ + { + "lessonID":"0.1.0", + "lessonSubject":"Mathematik 4", + "lessonTeacher":"Decker E.", + "lessonRoom":"B121, B206", + "lessonRemark":"" + }, + { + "lessonID":"0.1.1", + "lessonSubject":"Mathematik 4", + "lessonTeacher":"Orb", + "lessonRoom":"B206, B121", + "lessonRemark":"" + }, + { + "lessonID":"0.1.2", + "lessonSubject":"Einzeltermin", + "lessonTeacher":"Dorer", + "lessonRoom":"B014", + "lessonRemark":"Kolloquium betriebliche Praxis" + } + ] + ] + }, + ... + ] + } } ``` @@ -103,45 +95,58 @@ Section that contains the specification for the /mensamenu get request. /mensame ``` json { - "Monday": [ - { - "heading": "Essen 1", - "meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", - "additives": "" - }, - { - "heading": "Essen 2", - "meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", - "additives": "" - }, - { - "heading": "Buffet", - "meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", - "additives": "" - }, - ... - ], - "Tuesday": [ - { - "heading": "Essen 1", - "meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", - "additives": "" - }, - { - "heading": "Essen 2", - "meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", - "additives": "" - }, - { - "heading": "Buffet", - "meal": "Cordon bleu vom Schwein\nBratensauce\nPommes frites\nBeilagensalat ", - "additives": "" - }, - ... - ], - ... + "meta":{ + "mensaName":"Offenburg", + "time":1552423539 + }, + "currentWeek":{ + "days":[ + { + "meals":[ + { + "day":"Montag 11.03.", + "heading":"Essen 1", + "parts":[ + "Gnocchi", + "Salbeibutter", + "Tomaten-Pilzragout", + "Geriebener Mozzarella", + "Beilagensalat" + ], + "additives":"enthält Allergene: Ei,Se,Gl,GlW,ML" + }, + { + "day":"Montag 11.03.", + "heading":"Essen 2", + "parts":[ + "Geflügel Saté-Spieß", + "Erdnusssauce", + "Butterreis", + "Chinagemüse" + ], + "additives":"enthält Allergene: Ei,Er,So,Sn,Fi,Se,Sa,Gl,GlW,GlG,ML" + }, + { + "day":"Montag 11.03.", + "heading":"Buffet", + "parts":[ + "Grill und Salatbar", + "Asiatisches aus dem Wok", + "Fleisch- und Fischspezialitäten", + "Pasta-, Reis und Kartoffelvariationen", + "Gemüse" + ], + "additives":"" + } + ], + ... + } + ] + }, + "nextWeek":{ + ... + } } - ```