Method: courses.list

Renvoie une liste des cours que l'utilisateur demandeur est autorisé à consulter, limitée à ceux qui correspondent à la requête. Les cours renvoyés sont classés par date de création, en commençant par les plus récents.

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

  • PERMISSION_DENIED en cas d'erreurs d'accès.
  • INVALID_ARGUMENT si l'argument de requête est mal formé.
  • NOT_FOUND si des 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 qui ont un élève avec l'identifiant spécifié. L'identifiant peut être l'un des 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

Si elle est spécifiée, teacherId doit être vide.
teacherId

string

Limite les cours renvoyés à ceux qui ont un enseignant avec l'identifiant spécifié. L'identifiant peut être l'un des 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

Si elle est spécifiée, studentId doit être vide.
courseStates[]

enum (CourseState)

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

integer

Nombre maximal d'éléments à renvoyer. La valeur zéro ou non spécifiée indique que le serveur peut attribuer un maximum.

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.

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 lors de la liste des cours.

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.

Niveaux d'accès 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 sur l'autorisation.