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

Update page 'API Documentaion'

Jannik 2019-05-23 14:54:26 +02:00
parent da8c6ec99e
commit cf59d75932
1 changed files with 45 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
API-Documentaion.md

@ -1,7 +1,7 @@
## API Documentaion
This section contains all needed infromation to access the TheCitadelofRicks API. It also contains the API specification.
### /courses
### /course
/courses returns a Array "courses" of all currently available courses at the HS Offenburg with their name and link to the timetable (current/first week).
``` json
@ -91,6 +91,50 @@ Each lesson has the following values:
```
### /lessonSubjectList?courseName={coursename}&week={week}
/lessonSubjectList returns a HashSet with all unique lesson subjects of the given course and week.
``` json
[
"Softw. Engin. 2",
"Sem. IT-Anwendungen",
"Prakt. Masch.Prog.",
"Masch. Programm.",
"Datenbanksyst. 2a",
"Mathematik 4",
"Datenbanksyst. 2b"
]
```
### /lesson returns a?courseName={coursename}&lessonSubject={lessonsubject}&week={week}
/lesson returns a ArrayList of Lessons.
``` json
[
{
"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.2.0",
"lessonSubject":"Mathematik 4",
"lessonTeacher":"Decker E.",
"lessonRoom":"B121, B206",
"lessonRemark":""
},
...
]
```
### /mensamenu
/mensamenu returns two Arrays containing this and next weeks mensa menus. The respones contains a Array "days" of the type Meals for each day of the week (Monday to Sunday), meals therefor contains a ArrayList of n meals.