Gibt eine Liste der Erziehungsberechtigten zurück, die vom Nutzer angefordert werden dürfen, gefiltert nach den angegebenen Parametern.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn einstudentId
angegeben ist und der anfragende Nutzer keine Einladungen zu Erziehungsberechtigten für diesen Schüler/Studenten sehen darf, wenn"-"
alsstudentId
angegeben ist und der Nutzer kein Domainadministrator ist, wenn Erziehungsberechtigte nicht für die betreffende Domain aktiviert sind oder wenn andere Zugriffsfehler vorliegen.INVALID_ARGUMENT
, wenn einstudentId
angegeben ist, sein Format aber nicht erkannt werden kann. Es handelt sich weder um eine E-Mail-Adresse noch um einstudentId
aus der API oder das Literalstringme
. Kann auch zurückgegeben werden, wenn ein ungültigerpageToken
- oderstate
-Wert angegeben ist.NOT_FOUND
, wenn einestudentId
angegeben ist und ihr Format erkannt werden kann, in Classroom jedoch keine Aufzeichnungen zu diesem Schüler/Studenten vorliegen.
HTTP-Anfrage
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
studentId |
Die ID des Schülers/Studenten, dessen Einladungen zu Erziehungsberechtigten zurückgegeben werden sollen. Die Kennung kann eine der folgenden sein:
|
Abfrageparameter
Parameter | |
---|---|
invitedEmailAddress |
Wenn angegeben, werden nur Ergebnisse mit dem angegebenen |
states[] |
Wenn angegeben, werden nur Ergebnisse mit den angegebenen |
pageToken |
Die |
pageSize |
Maximale Anzahl der zurückzugebenden Elemente. Null oder nicht angegeben bedeutet, 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 an Erziehungsberechtigte.
JSON-Darstellung |
---|
{
"guardianInvitations": [
{
object ( |
Felder | |
---|---|
guardianInvitations[] |
Einladungen von Erziehungsberechtigten, die der Listenanfrage entsprechen. |
nextPageToken |
Token, das die nächste Ergebnisseite angibt. 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 Übersicht zu OAuth 2.0.