Method: userProfiles.guardians.delete

Löscht einen Erziehungsberechtigten.

Der Erziehungsberechtigte erhält dann keine Benachrichtigungen mehr und kann nicht mehr über die API darauf zugreifen.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn für den anfragenden Nutzer kein Nutzer mit der angegebenen studentId sichtbar ist, wenn der anfragende Nutzer nicht berechtigt ist, Erziehungsberechtigte für den mit der studentId angegebenen Schüler zu verwalten, wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder bei anderen Zugriffsfehlern.
  • INVALID_ARGUMENT, wenn ein studentId angegeben ist, dessen Format jedoch nicht erkannt werden kann (es ist keine E-Mail-Adresse und kein studentId aus der API).
  • NOT_FOUND, wenn der anfragende Nutzer Erziehungsberechtigte für die angeforderte studentId ändern darf, für den Schüler oder Studenten mit der angegebenen guardianId aber kein Guardian-Eintrag vorhanden ist.

HTTP-Anfrage

DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

Der Schüler/Student, dessen Erziehungsberechtigter gelöscht werden soll. Eines der folgenden Betriebssysteme:

  • die numerische Kennung des Nutzers
  • E-Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt
guardianId

string

Das Feld id aus einer Guardian.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, ist der Antworttext ein leeres JSON-Objekt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.