Method: userProfiles.guardianInvitations.patch

Ändert die Einladung für Erziehungsberechtigte.

Die einzige gültige Änderung besteht derzeit darin, state von PENDING in COMPLETE zu ändern. Dies hat zur Folge, dass die Einladung zurückgezogen wird.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der aktuelle Nutzer keine Berechtigung zum Verwalten von Erziehungsberechtigten hat, Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder andere Zugriffsfehler vorliegen.
  • FAILED_PRECONDITION, wenn der Link für Erziehungsberechtigte nicht den Status PENDING hat.
  • INVALID_ARGUMENT, wenn das Format des angegebenen Studentenausweises nicht erkannt werden kann, d. h. weder eine E-Mail-Adresse noch ein userId von dieser API ist, die übergebene GuardianInvitation einen anderen state als COMPLETE hat oder wenn dadurch andere Felder als state geändert werden.
  • NOT_FOUND, wenn es sich bei dem angegebenen Studentenausweis um einen gültigen Schüler-/Studentenausweis handelt, Classroom aber keine Aufzeichnungen über diesen Schüler/Studenten hat, oder wenn sich das Feld id nicht auf die Einladung eines Erziehungsberechtigten bezieht, die Classroom bekannt ist.

HTTP-Anfrage

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

ID des Schülers/Studenten, dessen Einladung als Erziehungsberechtigter geändert werden soll
invitationId

string

Das Feld id von GuardianInvitation, das geändert werden soll.

Abfrageparameter

Parameter
updateMask

string (FieldMask format)

Maske, die angibt, welche Felder im Kurs aktualisiert werden sollen. Dieses Feld ist für eine Aktualisierung erforderlich. Die Aktualisierung schlägt fehl, wenn ungültige Felder angegeben sind. Die folgenden Felder sind gültig:

  • state

Wenn dieses Feld in einem Abfrageparameter festgelegt ist, sollte es so angegeben werden:

updateMask=<field1>,<field2>,...

Dies ist eine durch Kommas getrennte Liste voll qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von GuardianInvitation.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine 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.