Method: courses.students.list

Renvoie la liste des élèves de ce cours que l'utilisateur est autorisé à consulter.

Cette méthode renvoie les codes d'erreur suivants:

  • NOT_FOUND si le cours n'existe pas.
  • PERMISSION_DENIED pour les erreurs d'accès.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Identifiant du cours. Cet identifiant peut être l'identifiant attribué par Classroom ou un alias.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal d'éléments à renvoyer. La valeur par défaut est 30 si elle n'est pas spécifiée ou 0.

Le serveur peut renvoyer un nombre inférieur au nombre de résultats spécifié.
pageToken

string

Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée.

La requête list doit être identique à celle qui a généré ce jeton.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse lorsque vous listez des élèves.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
Champs
students[]

object (Student)

Élèves correspondant à la requête de liste.
nextPageToken

string

Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, aucun autre résultat n'est disponible.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez le guide d'autorisation.