Method: userProfiles.guardianInvitations.list

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 eine studentId angegeben ist und der anfragende Nutzer keine Einladungen zu den Erziehungsberechtigten des Schülers/Studenten ansehen darf, "-" als studentId 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 eine studentId angegeben ist, ihr Format jedoch nicht erkannt werden kann (es ist weder eine E-Mail-Adresse noch ein studentId von der API oder der literale String me). Kann auch zurückgegeben werden, wenn ein ungültiger pageToken- oder state-Wert angegeben wird.
  • NOT_FOUND, wenn studentId 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

string

ID des Schülers/Studenten, dessen Einladungen für Erziehungsberechtigte zurückgegeben werden sollen Folgende Kennzeichnungen sind möglich:

  • Numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das String-Literal "me", das den anfragenden Nutzer angibt
  • Das String-Literal "-". Das bedeutet, dass Ergebnisse für alle Schüler zurückgegeben werden sollen, bei denen der anfragende Nutzer berechtigt ist, Einladungen von Erziehungsberechtigten aufzurufen.

Abfrageparameter

Parameter
invitedEmailAddress

string

Wenn angegeben, werden nur Ergebnisse mit der angegebenen invitedEmailAddress zurückgegeben.
states[]

enum (GuardianInvitationState)

Wenn angegeben, werden nur Ergebnisse mit den angegebenen state-Werten zurückgegeben. Andernfalls werden Ergebnisse mit dem state PENDING zurückgegeben.
pageToken

string

nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde. Dieser gibt an, dass die nachfolgende Ergebnisseite zurückgegeben werden soll.

Die list-Anfrage muss ansonsten mit der Anfrage übereinstimmen, die zu diesem Token geführt hat.
pageSize

integer

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 (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Felder
guardianInvitations[]

object (GuardianInvitation)

Einladungen von Erziehungsberechtigten, die mit der Listenanfrage übereinstimmten.
nextPageToken

string

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.