Es erstellt eine Einladung für den Erziehungsberechtigten und sendet eine E-Mail an den Erziehungsberechtigten, in der er gebeten wird, zu bestätigen, dass er der Erziehungsberechtigte des Schülers ist.
Sobald der Erziehungsberechtigte die Einladung annimmt, wird sein state
in COMPLETED
geändert und er erhält Benachrichtigungen für Erziehungsberechtigte. Außerdem wird eine Guardian
-Ressource erstellt, die den aktiven Erziehungsberechtigten darstellt.
Für das Anfrageobjekt müssen die Felder studentId
und invitedEmailAddress
festgelegt sein. Wenn diese Felder nicht festgelegt werden oder keine anderen Felder in der Anfrage festgelegt sind, wird ein Fehler ausgegeben.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn der aktuelle Nutzer nicht berechtigt ist, Erziehungsberechtigte zu verwalten, der betreffende Erziehungsberechtigte hat bereits zu viele Anfragen für diesen Schüler/Studenten abgelehnt, Erziehungsberechtigte für die betreffende Domain nicht aktiviert oder andere Zugriffsfehler sind aufgetreten.RESOURCE_EXHAUSTED
, wenn der Schüler/Student oder Erziehungsberechtigte die Beschränkung für Erziehungsberechtigte überschritten hat.INVALID_ARGUMENT
, wenn die E-Mail-Adresse des Erziehungsberechtigten ungültig ist (z. B. weil sie zu lang ist) oder das Format des eingereichten Studentenausweises nicht erkannt wird (es ist weder eine E-Mail-Adresse noch eineuserId
von dieser API). Dieser Fehler wird auch zurückgegeben, wenn schreibgeschützte Felder festgelegt sind oder wenn das Feldstate
auf einen anderen Wert alsPENDING
festgelegt ist.NOT_FOUND
, wenn der angegebene Studentenausweis ein gültiger Schüler-/Studentenausweis ist, in Classroom aber keine Aufzeichnungen über diesen Schüler/Studenten vorliegen.ALREADY_EXISTS
, wenn es bereits eine ausstehende Einladung als Erziehungsberechtigter für den Schüler oder Studenten gibt undinvitedEmailAddress
angegeben ist oder wenn die angegebeneinvitedEmailAddress
mit dem Google-Konto einer vorhandenenGuardian
für diesen Nutzer übereinstimmt.
HTTP-Anfrage
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
guardianInvitation.studentId |
ID des Schülers/Studenten (im Standardformat) |
Anfragetext
Der Anfragetext enthält eine Instanz von GuardianInvitation
.
Antworttext
Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von GuardianInvitation
.
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.