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 ID.

Schreibgeschützt.

userId

string

ID des eingeladenen Nutzers.

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

  • Numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das String-Literal "me", das den anfragenden Nutzer angibt
courseId

string

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

role

enum (CourseRole)

Rolle, die der Nutzer einladen 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.
OWNER Eigentümer des Kurses.

Methoden

accept

Nimmt eine Einladung an, entfernt sie und fügt den eingeladenen Nutzer den Lehrkräften oder Schülern/Studenten 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 ansehen darf, wobei die Einladung auf die Einladungen beschränkt ist, die mit der Listenanfrage übereinstimmen.