REST Resource: invitations

Ressource: Invitation

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

ID des eingeladenen Nutzers.

Wenn diese ID als Parameter einer Anfrage angegeben wird, kann sie auf eine der folgenden Optionen festgelegt werden:

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

string

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

enum (CourseRole)

Rolle, zu der der Nutzer eingeladen werden soll. Darf nicht COURSE_ROLE_UNSPECIFIED sein.

CourseRole

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 Eigentümer des Kurses.

Methoden

accept

 Wenn eine Einladung angenommen wird, wird sie entfernt und der eingeladene Nutzer wird den Lehrkräften bzw. Schülern/Studenten für den angegebenen Kurs hinzugefügt.

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 anzeigen darf, beschränkt auf diejenigen, die der Listenanfrage entsprechen.