Method: userProfiles.guardianInvitations.get

Gibt eine bestimmte Einladung für Erziehungsberechtigte zurück.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer keine Einladungen für Erziehungsberechtigte für den mit studentId angegebenen Schüler/Studenten ansehen darf, 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, kein studentId aus der API und kein Literalstring me).
  • NOT_FOUND, wenn in Classroom keine Daten zu dem Schüler oder Studenten gefunden werden können, oder invitationId. Kann auch zurückgegeben werden, wenn der Schüler/Student existiert, der anfragende Nutzer aber keinen Zugriff auf diesen Schüler/Studenten hat.

HTTP-Anfrage

GET 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, für den die Einladung für den Erziehungsberechtigten angefordert wird.
invitationId

string

Das Feld id der angeforderten GuardianInvitation.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von GuardianInvitation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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.