Gibt eine Liste der Einladungen von Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf. Diese Liste ist nach den angegebenen Parametern gefiltert.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn einstudentId
angegeben ist und der anfragende Nutzer keine Einladungen für Erziehungsberechtigte für diesen Schüler oder Student sehen darf, wenn"-"
alsstudentId
angegeben wurde und der Nutzer kein Domainadministrator ist, Wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder wenn andere Zugriffsfehler auftretenINVALID_ARGUMENT
, wenn einstudentId
angegeben wird, sein Format jedoch nicht erkannt wird (es ist weder eine E-Mail-Adresse noch einstudentId
-Wert aus der API oder der Literalstringme
). Kann auch zurückgegeben werden, wenn eine ungültigepageToken
oder einestate
angegeben wurde.NOT_FOUND
, wenn einestudentId
angegeben und ihr Format erkannt wird. Classroom hat aber keine Informationen zu diesem Schüler/Studenten.
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 von Erziehungsberechtigten zurückgegeben werden sollen. Die Kennung kann eine der folgenden sein:
|
Suchparameter
Parameter | |
---|---|
invitedEmailAddress |
Wenn angegeben, werden nur Ergebnisse mit der angegebenen |
states[] |
Wenn angegeben, werden nur Ergebnisse mit den angegebenen |
pageToken |
Die Anfrage |
pageSize |
Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Null oder keine Angabe gibt an, dass der Server ein Maximum zuweisen kann. Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Antwort beim Auflisten von Einladungen für Erziehungsberechtigte.
JSON-Darstellung |
---|
{
"guardianInvitations": [
{
object ( |
Felder | |
---|---|
guardianInvitations[] |
Einladungen für Erziehungsberechtigte, die mit der Listenanfrage übereinstimmen. |
nextPageToken |
Token, das die nächste Ergebnisseite angibt, 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 in der OAuth 2.0-Übersicht.