Method: userProfiles.guardianInvitations.get

Gibt eine bestimmte Einladung zum Betreuer zurück.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer nicht berechtigt ist, die Erziehungsberechtigten-Einladungen des unter studentId angegebenen Schülers/Studenten anzusehen, Erziehungsberechtigte für die betreffende Domain nicht aktiviert 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 Classroom keine Aufzeichnungen über den angegebenen Schüler/Studenten oder invitationId finden kann. Kann auch zurückgegeben werden, wenn der Schüler/Student vorhanden ist, der anfragende Nutzer jedoch keinen Zugriff auf den 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

ID des Schülers/Studenten, dessen Einladung als Erziehungsberechtigter 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.