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

Jannik 2019-09-26 15:35:36 +02:00
parent 42a7318fd3
commit 7ae6aa57ba
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
API-Documentaion.md

@ -32,7 +32,7 @@ This section contains all needed infromation to access the TheCitadelofRicks API
/timetable returns a ArrayList "timetable" which contains a Array of 6 days, each day contains a Array of 6 ArrayLists which contain 0..n lessons. The meta part contains course-name, the actual timetable link, the last update-time and the week index (starting with 0 for the current week)
Each lesson has the following values:
* lessonID: formate: DAY.TIMESLOT.LESSON, range: 0.0.0 to 5.5.x (0.0.0 = Monday.firstTimeSlot.firstLesson, 5.6.x = Saturday.lastTimeSlot.lastLesson)
* lessonID: formate: DAY.TIMESLOT.LESSON, range: 0.0.0 to 5.5.x (0.0.0 = Monday.firstTimeslot.firstLesson, 5.6.x = Saturday.lastTimeslot.lastLesson)
* subject: the lesson subject
* teacher: the lesson teacher
* room: the room in which the lesson takes place
@ -107,7 +107,15 @@ Each lesson has the following values:
```
### /lesson?courseName={coursename}&lessonSubject={lessonsubject}&week={week}
/lesson returns a ArrayList of Lessons.
/lesson returns a ArrayList of Lessons for a subject with a given course and week.
Each lesson has the following values:
* lessonID: formate: DAY.TIMESLOT.LESSON, range: 0.0.0 to 5.5.x (0.0.0 = Monday.firstTimeslot.firstLesson, 5.6.x = Saturday.lastTimeslot.lastLesson)
* subject: the lesson subject
* teacher: the lesson teacher
* room: the room in which the lesson takes place
* remark: additional info
``` json
[
{
@ -136,7 +144,13 @@ Each lesson has the following values:
```
### /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.
/mensamenu returns two Arrays containing this and next weeks mensa menus. The respones contains an Array "days" of the type Meals for each day of the week (Monday to Sunday), meals therefor contains a ArrayList of n meals.
Each meal (element of meals) has the following values:
* day: the day on which this meal is served
* heading: the heading from the swfr website
* parts: an Array of all parts of the meal
* additives: info about alln additives in this meal
``` json
{