Method: courses.list

Affiche la liste des cours que l'utilisateur à l'origine de la requête est autorisé à consulter, limités à ceux qui correspondent à la requête. Les cours renvoyés sont classés par heure de création, les plus récents étant créés en premier.

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

  • PERMISSION_DENIED pour les erreurs d'accès
  • INVALID_ARGUMENT si l'argument de requête est mal formé.
  • NOT_FOUND si les utilisateurs spécifiés dans les arguments de requête n'existent pas.

Requête HTTP

GET https://classroom.googleapis.com/v1/courses

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
studentId

string

Limite les cours renvoyés à ceux dont l'identifiant correspond à celui d'un élève. Il peut s'agir de l'un des types d'identifiants suivants:

  • l'identifiant numérique de l'utilisateur
  • L'adresse e-mail de l'utilisateur
  • Le littéral de chaîne "me", indiquant l'utilisateur demandeur
teacherId

string

Limite les cours renvoyés à ceux ayant un enseignant avec l'identifiant spécifié. Il peut s'agir de l'un des types d'identifiants suivants:

  • l'identifiant numérique de l'utilisateur
  • L'adresse e-mail de l'utilisateur
  • Le littéral de chaîne "me", indiquant l'utilisateur demandeur
courseStates[]

enum (CourseState)

Limite les cours renvoyés à ceux se trouvant dans l'un des états spécifiés. La valeur par défaut est ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

Nombre maximal d'articles à renvoyer. "0" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer moins de résultats que le nombre 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.

Par ailleurs, 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 la liste des cours est listée.

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

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

object (Course)

Cours 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.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Pour en savoir plus, consultez le Guide relatif aux autorisations.