Method: courses.students.list

Gibt eine Liste der Teilnehmer dieses Kurses zurück, die der Anfragende ansehen darf.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • NOT_FOUND, wenn der Kurs nicht vorhanden ist.
  • PERMISSION_DENIED für Zugriffsfehler.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

ID des Kurses. Diese Kennung kann entweder die von Classroom zugewiesene Kennung oder eine alias sein.

Abfrageparameter

Parameter
pageSize

integer

Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Wenn nicht angegeben, ist der Standardwert 30 oder 0.

Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück.
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.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort beim Auflisten von Schülern/Studenten.

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

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

object (Student)

Schüler/Studenten, die der Listenanfrage entsprechen.
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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.