REST Resource: invitations

Zasób: Invitation

Zaproszenie do dołączenia do zajęć.

Zapis JSON 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Pola
id

string

Identyfikator przypisany przez Classroom.

Tylko do odczytu.
userId

string

Identyfikator zaproszonego użytkownika.

Gdy identyfikator jest określony jako parametr żądania, może mieć jedną z tych wartości:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika,
  • literał ciągu "me", który wskazuje użytkownika wysyłającego żądanie
courseId

string

Identyfikator szkolenia, na które ma zostać zaproszony użytkownik.
role

enum (CourseRole)

Rola, którą chcesz przyznać użytkownikowi. Nie może wynosić COURSE_ROLE_UNSPECIFIED.

CourseRole

Możliwe role, do których użytkownik może otrzymać zaproszenie.

Wartości w polu enum
COURSE_ROLE_UNSPECIFIED Brak roli szkolenia.
STUDENT Uczeń na zajęciach.
TEACHER Nauczyciel, który prowadzi zajęcia.
OWNER Właściciel zajęć.

Metody

accept

 Przyjmuje zaproszenie, usuwa je i dodaje zaproszonego użytkownika do nauczycieli lub uczniów (w stosownych przypadkach) na określonych zajęciach.

create

 Tworzy zaproszenie.

delete

 Usuwa zaproszenie.

get

 Zwraca zaproszenie.

list

 Zwraca listę zaproszeń, które użytkownik wysyłający prośbę może wyświetlić, ograniczoną do tych, które pasują do żądania listy.