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

Update page 'API Documentaion'

Jannik 2019-03-16 00:20:05 +01:00
parent 84b2203ec0
commit 1d0fb799f0
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
API-Documentaion.md

@ -2,8 +2,7 @@
This section contains all needed infromation to access the TheCitadelofRicks API. It also contains the API specification.
### /courses
Section that contains the specification for the courses get request. /courses returns a array of all available courses.
/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
{
@ -93,7 +92,7 @@ Each lesson has the following values:
```
### /mensamenu
Section that contains the specification for the /mensamenu get request. /mensamenu returns a array containing this weeks mensa menu. The respones contains 6 arrays (Monday to Saturday), each with n meals.
/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.
``` json
{