Method: userProfiles.guardians.get

Gibt einen bestimmten Erziehungsberechtigten zurück.

Diese Methode gibt die folgenden Fehlercodes zurück:

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

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

Der Schüler oder Student, dessen Erziehungsberechtigter angefragt wird. 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, enthält der Antworttext eine Instanz von Guardian.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.