REST Resource: invitations

Ресурс: Приглашение

Приглашение присоединиться к курсу.

JSON-представление
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Поля
id

string

Идентификатор, назначенный Классом.

Только для чтения.

userId

string

Идентификатор приглашенного пользователя.

Если этот идентификатор указан в качестве параметра запроса, ему может быть присвоено одно из следующих значений:

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий запрашивающего пользователя
courseId

string

Идентификатор курса, на который можно пригласить пользователя.

role

enum ( CourseRole )

Роль, которую можно пригласить пользователя. Не должно быть COURSE_ROLE_UNSPECIFIED .

КурсРоль

Возможные роли, на которые может быть приглашен пользователь.

Перечисления
COURSE_ROLE_UNSPECIFIED Никакой конечной роли.
STUDENT Студентка на курсе.
TEACHER Преподаватель курса.
OWNER Владелец курса.

Методы

accept

 Принимает приглашение, удаляя его и добавляя приглашенного пользователя в число преподавателей или студентов (в зависимости от обстоятельств) указанного курса.

create

 Создает приглашение.

delete

 Удаляет приглашение.

get

 Возвращает приглашение.

list

 Возвращает список приглашений, которые запрашивающему пользователю разрешено просматривать, ограниченный теми, которые соответствуют запросу списка.