-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Tasks to-do
- Session settings
- Create new session
- Cancel session by tutor
- Cancel session by student
- Rate conducted session
Functionality
-
GET
/session/formats
To know exist session formats you can send this (or hard code these values on frontend side, so don’t need to ask each time). -
GET
/session/types
To know exist session types you can send this (or hard code these values on frontend side, so don’t need to ask each time). -
GET
/session/subjects
To know exist subjects you can send this. -
GET
/session/students
If you want to conduct a new session with your accepted students, you probably want to see who can you add for a particular subject, session format and session type.
Specifying these parameters (subject, format and type), you will get a list of your suitable students for these particular parameters.So, you can easily see available students, which you can add to a new session.
- subject - get a list of available subjects using
GET /session/subjects - format = [offline, online]
- type = [private, group]
You can specify a subject, a format, and a type, but these fields are not strictly required.
To create a new session with your students, check
POST /session - subject - get a list of available subjects using
-
POST
/session
Create a new session with your accepted students.In studentIDsList field you need to specify a list of your student's IDs
- You can't edit your session
- You can't choose several students if session's type is private. So studentIDsList must contains only single ID.
- You need to specify
startTimenot less than the the current time.
-
DELETE
/session/cancel/{id}
Cancel created session specifyingsessionIdas a path variable. You can not cancel already conducted sessions.- If you are a student you will be just unattached from this session.
- If you are a tutor you will just delete this session, so it also will disappear from students as well.
-
PUT
/session/rate
Rate conducted session.- Only a student attached to this session can rate it.
- A student can rate the session only if it has already been finished (
endTimeis less than the current time). Markis an integer, it belongs to [1; 5].- If 'Mark' is null the rating will be deleted. Alternatively, you can use DELETE
/session/rate/{id}request. - Also, you can prove string feedback up to 256 characters.
-
DEL
/session/rate/{id}
Delete your rating to the conducted session specifying itssessionIDas a path variable.- Only a student can delete his/her rating to a session.
- Alternatively, you can use PUT
/session/raterequest specifying"mark": null.