Method: userProfiles.guardianInvitations.list

Gibt eine Liste der Einladungen für Erziehungsberechtigte 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 nicht berechtigt ist, die Einladungen für Erziehungsberechtigte für diesen Schüler/Studenten anzusehen, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, wenn keine Erziehungsberechtigten für die betreffende Domain aktiviert sind oder wenn andere Zugriffsfehler vorliegen.
  • INVALID_ARGUMENT, wenn eine studentId angegeben ist, ihr Format jedoch nicht erkannt wird (weder eine E-Mail-Adresse noch ein studentId von der API noch der literale String me). Kann auch zurückgegeben werden, wenn ein ungültiger pageToken oder state angegeben wird.
  • NOT_FOUND, wenn eine studentId angegeben ist und ihr Format erkannt werden kann, aber in Classroom sind keine Aufzeichnungen zu diesem Schüler/Studenten vorhanden.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

Die ID des Schülers, dessen Einladungen als Erziehungsberechtigte zurückgegeben werden sollen. Folgende Kennzeichnungen sind möglich:

  • die numerische Kennung für den Nutzer,
  • die E-Mail-Adresse des Nutzers
  • Das Stringliteral "me", das den anfragenden Nutzer angibt
  • Das Stringliteral "-", das angibt, dass die Ergebnisse für alle Schüler zurückgegeben werden sollen, denen der anfragende Nutzer berechtigt ist, Einladungen für Erziehungsberechtigte anzusehen.

Abfrageparameter

Parameter
invitedEmailAddress

string

Wenn angegeben, werden nur Ergebnisse mit dem 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-Wert PENDING zurückgegeben.
pageToken

string

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

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

integer

Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server einen Höchstwert zuweisen kann.

Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen 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 für Erziehungsberechtigte, die mit der Listenanfrage übereinstimmen.
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.