REST Resource: invitations

Ressource: Einladung

Eine Einladung zur Teilnahme an einem Kurs.

JSON-Darstellung 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Felder
id

string

Von Classroom zugewiesene Kennung.

Schreibgeschützt.
userId

string

Kennung des eingeladenen Nutzers.

Wenn diese Kennung als Parameter einer Anfrage angegeben wird, kann sie einen der folgenden Werte haben:

  • die numerische Kennung des Nutzers
  • E-Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt
courseId

string

Kennung des Kurses, zu dem der Nutzer eingeladen werden soll.
role

enum (CourseRole)

Rolle, die der Nutzer haben soll. Darf nicht COURSE_ROLE_UNSPECIFIED sein.

CourseRole

Mögliche Rollen, zu denen ein Nutzer eingeladen werden kann.

Enums
COURSE_ROLE_UNSPECIFIED Keine Kursrolle.
STUDENT Schüler/Student im Kurs.
TEACHER Lehrkraft des Kurses.
OWNER Inhaber des Kurses.

Methoden

accept

 Akzeptiert eine Einladung, entfernt sie und fügt den eingeladenen Nutzer den Lehrkräften oder Schülern/Studenten (je nach Fall) des angegebenen Kurses hinzu.

create

 Erstellt eine Einladung.

delete

 Löscht eine Einladung.

get

 Gibt eine Einladung zurück.

list

 Gibt eine Liste der Einladungen zurück, die der anfragende Nutzer sich ansehen darf. Sie ist auf die Einladungen beschränkt, die der Listenanfrage entsprechen.