Method: userProfiles.guardianInvitations.create

Erstellt eine Einladung für den Erziehungsberechtigten und sendet ihm eine E-Mail, in der er gebeten wird, zu bestätigen, dass er der Erziehungsberechtigte des Schülers oder Studenten ist.

Sobald der Erziehungsberechtigte die Einladung angenommen hat, ändert sich sein state in COMPLETED 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 andere Felder in der Anfrage festgelegt werden, führt dies zu einem Fehler.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der aktuelle Nutzer keine Berechtigung zum Verwalten von Erziehungsberechtigten hat, wenn der betreffende Erziehungsberechtigte bereits zu viele Anfragen für diesen Schüler/Studenten abgelehnt hat, wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder bei anderen Zugriffsfehlern.
  • RESOURCE_EXHAUSTED, wenn der Schüler oder Erziehungsberechtigte die maximale Anzahl von Verknüpfungen mit Erziehungsberechtigten überschritten hat.
  • INVALID_ARGUMENT, wenn die E-Mail-Adresse des Erziehungsberechtigten ungültig ist (z. B. zu lang) oder das Format der angegebenen Schüler-/Studentennummer nicht erkannt werden kann (es handelt sich nicht um eine E-Mail-Adresse oder eine userId aus dieser API). Dieser Fehler wird auch zurückgegeben, wenn schreibgeschützte Felder festgelegt sind oder das Feld state auf einen anderen Wert als PENDING gesetzt ist.
  • NOT_FOUND: Die angegebene Schüler-/Studenten-ID ist gültig, aber in Classroom ist kein Eintrag für diesen Schüler/Studenten vorhanden.
  • ALREADY_EXISTS, wenn für den Schüler/Studenten bereits eine ausstehende Einladung für Erziehungsberechtigte vorliegt und invitedEmailAddress angegeben wurde, oder wenn die angegebene invitedEmailAddress mit dem Google-Konto einer vorhandenen Guardian 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

string

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.