Method: userProfiles.guardianInvitations.patch

Ändert eine Einladung für Erziehungsberechtigte.

Derzeit ist die einzige gültige Änderung, den Wert von state von PENDING in COMPLETE zu ändern. Dadurch wird die Einladung zurückgezogen.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der aktuelle Nutzer nicht berechtigt ist, Erziehungsberechtigte zu verwalten, Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder bei anderen Zugriffsfehlern.
  • FAILED_PRECONDITION, wenn der Link zum Erziehungsberechtigten nicht den Status PENDING hat.
  • INVALID_ARGUMENT, wenn das Format der angegebenen Schüler-/Studenten-ID nicht erkannt werden kann (es handelt sich nicht um eine E-Mail-Adresse oder eine userId aus dieser API), oder wenn die übergebene GuardianInvitation eine andere state als COMPLETE hat oder andere Felder als state geändert werden.
  • NOT_FOUND, wenn die angegebene Schüler-/Studenten-ID gültig ist, aber in Classroom keine Daten zu diesem Schüler/Studenten vorhanden sind, oder wenn sich das Feld id nicht auf eine Erziehungsberechtigten-Einladung bezieht, die in 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

Die ID des Schülers oder Studenten, dessen Einladung für Erziehungsberechtigte geändert werden soll.
invitationId

string

Das Feld id der zu ändernden GuardianInvitation.

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 werden. Die folgenden Felder sind zulässig:

  • state

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

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

Dies ist eine durch Kommas getrennte Liste vollständig 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.