Method: userProfiles.guardianInvitations.list

Gibt eine Liste der Einladungen an Erziehungsberechtigte zurück, die der anfragende Nutzer sich 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 für Erziehungsberechtigte für diesen Schüler/Studenten ansehen darf, wenn "-" als studentId angegeben ist und der Nutzer kein Domainadministrator ist, wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder bei anderen Zugriffsfehlern.
  • INVALID_ARGUMENT, wenn eine studentId angegeben ist, deren Format jedoch nicht erkannt werden kann (es handelt sich nicht um eine E-Mail-Adresse, eine studentId aus der API oder den Literalstring me). Wird auch zurückgegeben, wenn eine ungültige pageToken oder state angegeben wird.
  • NOT_FOUND, wenn eine studentId angegeben ist und das Format erkannt werden kann, in Classroom aber keine Daten zu diesem 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

Die ID des Schülers oder Studenten, dessen Einladungen an Erziehungsberechtigte zurückgegeben werden sollen. Die Kennung kann eine der folgenden sein:

  • die numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt
  • den Stringliteral "-", der angibt, dass Ergebnisse für alle Schüler zurückgegeben werden sollen, für die der anfragende Nutzer die Einladungen der Erziehungsberechtigten ansehen darf.

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 einem state von PENDING zurückgegeben.
pageToken

string

nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde und angibt, dass die nächste Ergebnisseite zurückgegeben werden soll.

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

integer

Die maximale Anzahl der Elemente, die zurückgegeben werden sollen. „0“ 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

Antwort, wenn Erziehungsberechtigte eingeladen werden

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Felder
guardianInvitations[]

object (GuardianInvitation)

Einladungen an Erziehungsberechtigte, die der Listenanfrage entsprechen.
nextPageToken

string

Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Ist das Feld leer, 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.