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.

Jeśli określisz go jako parametr żądania, można go ustawić na jeden z tych parametrów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika.
  • literał ciągu znaków "me" wskazujący użytkownika wysyłającego żądanie
courseId

string

Identyfikator zajęć, na które można zaprosić użytkownika.

role

enum (CourseRole)

Rola, do której należy zaprosić użytkownika. Wartość nie może być wartością 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 na zajęciach.
STUDENT Uczeń biorący udział w zajęciach.
TEACHER Nauczycielka kursu.
OWNER Właściciel zajęć.

Metody

accept

Akceptuje zaproszenie i usuwa zaproszenie, a następnie dodaje zaproszonego użytkownika do nauczycieli lub uczniów konkretnych zajęć.

create

Tworzy zaproszenie.

delete

Usuwa zaproszenie.

get

Zwraca zaproszenie.

list

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