Method: courses.list

Affiche la liste des cours que l'utilisateur à l'origine de la requête est autorisé à consulter, en les limitant à ceux qui correspondent à la requête. Les cours renvoyés sont classés par date de création, les plus récents 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 la requête est incorrect.
  • NOT_FOUND si des utilisateurs spécifiés dans les arguments de la 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 ayant un élève avec l'identifiant spécifié. L'identifiant peut être l'un des éléments suivants:

  • Identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • le littéral de chaîne "me", qui indique l'utilisateur à l'origine de la requête
teacherId

string

Limite les cours renvoyés à ceux dont l'enseignant possède l'identifiant spécifié. L'identifiant peut être l'un des éléments suivants:

  • Identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • le littéral de chaîne "me", qui indique l'utilisateur à l'origine de la requête
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" et "DECLINED".
pageSize

integer

Nombre maximal d'éléments à renvoyer. Une valeur nulle ou non spécifiée indique que le serveur peut attribuer une valeur maximale.

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 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.

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 d'autorisation.