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 er nicht berechtigt ist, die Informationen zu den Erziehungsberechtigten für den in der studentId angegebenen Schüler abzurufen, wenn keine Erziehungsberechtigten für die betreffende Domain aktiviert sind oder andere Zugriffsfehler vorliegen.
  • INVALID_ARGUMENT, wenn ein studentId angegeben ist, sein Format jedoch nicht erkannt werden kann (es ist weder eine E-Mail-Adresse noch ein studentId von der API oder der literale String me).
  • NOT_FOUND, wenn der anfragende Nutzer berechtigt ist, die Erziehungsberechtigten für die angefragte studentId aufzurufen, aber kein Guardian-Eintrag für diesen Schüler/Studenten 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

Schüler, dessen Erziehungsberechtigter angefordert wird Eines der folgenden Betriebssysteme:

  • Numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das String-Literal "me", das den anfragenden Nutzer angibt
guardianId

string

Das Feld id aus einem 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.