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

Update page 'API Documentaion'

Jannik 2019-03-15 23:49:23 +01:00
parent b0f988c4b5
commit d77f1d9a80
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
API-Documentaion.md

@ -29,8 +29,9 @@ Section that contains the specification for the courses get request. /courses re
}
```
### /timetable?courseName={coursename}
Section that contains the specification for the /timetable/{coursename} get request. /timetable/{coursename} returns 6 arrays (Monday to Saturday) containing the timetable. Each array (day) contains 7 lessons.
### /timetable?courseName={coursename}&week={week}
/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)
* subject: the lesson subject