/
reservered for frontend static files
-
/api/register
Register a new user.{ "name": "Mathias", "surname": "Hertzel (optional)", "email": "mathias.hertzel@example.com", "password": "supersecret" }
{ "name": "Mathias", "surname": "Hertzel", "email": "mathias.hertzel@example.com", "password": "supersecret" }
-
/api/login
Login an existing user.{ "email": "mathias.hertzel@example.com", "password": "supersecret" }
{ "name": "Mathias", "surname": "Hertzel", "email": "mathias.hertzel@example.com" }
-
/api/logout
Logout current user.
-
/api/v1/me
GET own user (based on SessionToken).{ "id": "12345", "name": "Mathias", "surname": "Hertzel", "email": "mathias.hertzel@gmail.com" }
-
/api/v1/users
GET all users[ { "id": "12345", "name": "Mathias", "surname": "Herzel", "email": "mathias.hertzel@gmail.com", "profilePicture": "http://example.com" } ]
-
/api/v1/users/:id
GET users.{ "id": "12345", "name": "Mathias", "surname": "Hertzel", "email": "mathias.hertzel@gmail.com" }
-
/api/v1/users/:id/courses
GET all courses a member is subscribed to[ { "id:": "1", "title": "Course 1", "description": "a short description" }, { "id": "2", "title": "Course 2", "description": "another short description", "entries": [ { "id": "1", "date": "2018-07-01T15:04:05-07:00", "message": "test test", "pictures": [ "https://example.com/picture1.png", "https:/example.com/picture2.jpg" ] } ], "schedules": [ { "day": 0, "startsAt": "2018-06-24T08:52:28.764Z", "room": "EN 154", "title": "meme Class" } ] } ]
Remarks: Day 0 indicates Sunday, 1 is Monday and so on...
-
/api/v1/courses/
GET all accessible courses[ { "id:": "1", "title": "Course 1", "description": "a short description" }, { "id": "2", "title": "Course 2", "description": "another short description" } ]
-
/api/v1/courses/:id
GET a certain course{ "id": "1", "title": "Course 1", "description": "a short description", "members": [ "12345", "12346" ], "labels": [ "123", "124" ], "entries": [ { "id": "1", "date": "2018-07-01T15:04:05-07:00", "message": "test test", "pictures": [ "https://example.com/picture1.png", "https:/example.com/picture2.jpg" ] }, { "id": "2", "date": "2018-06-20 15:12:48", "message": "hello world", "pictures": [ "https://example.com/picture1.png", "https:/example.com/picture2.jpg" ] } ], "schedules": [ { "day": 0, "startsAt": "2018-06-24T08:52:28.764Z", "room": "EN 154", "title": "meme Class" } ] }
Remarks: Day 0 indicates Sunday, 1 is Monday and so on...
-
/api/v1/courses/:id/users
GET all subscribed members from a course[ { "id": "12345", "name": "Mathias", "surname": "Hertzel", "email": "mathias.hertzel@gmail.com" }, { "id": "12345", "name": "Mathias", "surname": "Hertzel", "email": "mathias.hertzel@gmail.com" } ]
-
/api/v1/courses/:id/users/subscribe
POST user ids that will be subscribed to the courseInput
[ { "id": "1" }, { "id": "2" } ]
-
/api/v1/courses/:id/users/unsubscribe
POST user ids that will be unsubscribed from the courseInput
[ { "id": "1" }, { "id": "2" } ]
-
/api/v1/courses/:courseId/entries
POST new entry that will be added to the courseInput
{ "date": "2018-07-01T15:04:05-07:00", "message": "herpy derpy new messagerpy", "pictures": [ "https://example.com/course/picture1", "https://example.com/course/picture2" ], "published": true }
Output
{ "id": "1", "date": "2018-07-01T15:04:05-07:00", "message": "herpy derpy new messagerpy", "pictures": [ "https://example.com/course/picture1", "https://example.com/course/picture2" ], "published": true }
-
/api/v1/courses/:courseId/entries/:entryId
PUT updates in entry from a course (not yet implemented)Input
{ "date":"2018-07-01T20:04:05-07:00", "message": "herpy derpy", "pictures": [ "https://example.com/course/picture1", "https://example.com/course/picture2" ], "published": false }
Output
{ "id": "1", "date": "2018-07-01T20:04:05-07:00", "message": "herpy derpy", "pictures": [ "https://example.com/course/picture1", "https://example.com/course/picture2" ], "published": false }
-
/api/v1/courses/:courseID/entries/:entryId
DELETE selected entry from a course