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:55:24 +02:00
parent cf59d75932
commit 42a7318fd3
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

@ -1,8 +1,8 @@
## API Documentaion ## API Documentaion
This section contains all needed infromation to access the TheCitadelofRicks API. It also contains the API specification. This section contains all needed infromation to access the TheCitadelofRicks API. It also contains the API specification.
### /course ### /courseList
/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). /courseList 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 ``` json
{ {
@ -106,7 +106,7 @@ Each lesson has the following values:
``` ```
### /lesson returns a?courseName={coursename}&lessonSubject={lessonsubject}&week={week} ### /lesson?courseName={coursename}&lessonSubject={lessonsubject}&week={week}
/lesson returns a ArrayList of Lessons. /lesson returns a ArrayList of Lessons.
``` json ``` json
[ [