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

update doc to API version 1.2.0

Jannik 2020-06-05 18:32:05 +02:00
parent 8c653655cc
commit 8bc953ad4a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
API-Documentaion.md

@ -28,7 +28,7 @@ This section contains all needed infromation to access the TheCitadelofRicks API
}
```
### /timetable?courseName={coursename}&week={week}
### /timetable?course={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:
@ -91,7 +91,7 @@ Each lesson has the following values:
```
### /lessonSubjectList?courseName={coursename}&week={week}
### /subjectList?course={coursename}&week={week}
/lessonSubjectList returns a HashSet with all unique lesson subjects of the given course and week.
``` json
[
@ -106,7 +106,7 @@ Each lesson has the following values:
```
### /lessons?courseName={coursename}&lessonSubject={lessonsubject}&week={week}
### /lessons?course={coursename}&subject={subject}&week={week}
/lesson returns a ArrayList of Lessons for a subject with a given course and week.
Each lesson has the following values: