Gibt eine Liste mit Einladungen von Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf, gefiltert nach den angegebenen Parametern.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn einestudentId
angegeben ist und der anfragende Nutzer keine Einladungen zu den Erziehungsberechtigten des Schülers/Studenten ansehen darf,"-"
alsstudentId
angegeben ist und der Nutzer kein Domainadministrator ist, wenn keine Erziehungsberechtigten für die betreffende Domain aktiviert sind oder andere Zugriffsfehler vorliegen.INVALID_ARGUMENT
, wenn einestudentId
angegeben ist, ihr Format jedoch nicht erkannt werden kann (es ist weder eine E-Mail-Adresse noch einstudentId
von der API oder der literale Stringme
). Kann auch zurückgegeben werden, wenn ein ungültigerpageToken
- oderstate
-Wert angegeben wird.NOT_FOUND
, wennstudentId
angegeben wurde und sein Format erkannt werden kann, in Classroom aber keine Aufzeichnungen über diesen Schüler/Studenten vorhanden sind.
HTTP-Anfrage
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
studentId |
ID des Schülers/Studenten, dessen Einladungen für Erziehungsberechtigte zurückgegeben werden sollen Folgende Kennzeichnungen sind möglich:
|
Abfrageparameter
Parameter | |
---|---|
invitedEmailAddress |
Wenn angegeben, werden nur Ergebnisse mit der angegebenen |
states[] |
Wenn angegeben, werden nur Ergebnisse mit den angegebenen |
pageToken |
Die |
pageSize |
Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server ein Maximum zuweisen kann. Der Server gibt möglicherweise weniger Ergebnisse als die angegebene Anzahl zurück. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort beim Auflisten von Einladungen für Erziehungsberechtigte.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"guardianInvitations": [
{
object ( |
Felder | |
---|---|
guardianInvitations[] |
Einladungen von Erziehungsberechtigten, die mit der Listenanfrage übereinstimmten. |
nextPageToken |
Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Wenn das Feld leer ist, sind keine weiteren Ergebnisse verfügbar. |
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.