REST Resource: invitations

Zasób: Zaproszenie

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 jest on określony jako parametr żądania, może mieć jedną z tych wartości:

  • identyfikator liczbowy użytkownika;
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;
courseId

string

Identyfikator zajęć, do których chcesz zaprosić użytkownika.
role

enum (CourseRole)

Rola, jaką ma mieć zaproszony użytkownik. Nie może to być COURSE_ROLE_UNSPECIFIED.

CourseRole

Możliwe role, które użytkownik może przyjąć.

Wartości w polu enum
COURSE_ROLE_UNSPECIFIED Brak roli na zajęciach.
STUDENT Uczestnik kursu.
TEACHER Nauczyciel prowadzący zajęcia.
OWNER Właściciel zajęć.

Metody

accept

 akceptuje zaproszenie, usuwa je i dodaje zaproszonego użytkownika do listy nauczycieli lub uczniów (w zależności od tego, co jest odpowiednie) w określonym kursie.

create

 Tworzy zaproszenie.

delete

 Usuwa zaproszenie.

get

 Zwraca zaproszenie.

list

 Zwraca listę zaproszeń, które użytkownik może wyświetlić, ograniczając się do tych, które pasują do żądania listy.