Method: courses.list

Affiche une liste de cours que l'utilisateur à l'origine de la demande est autorisé à consulter, limitées à ceux qui correspondent à la requête. Les cours proposés sont triés par date de création (les plus récents apparaissent en premier).

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

  • PERMISSION_DENIED pour les erreurs d'accès.
  • INVALID_ARGUMENT si le format de l'argument de requête est incorrect.
  • NOT_FOUND si les 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 dont l'élève possède l'identifiant spécifié. Il peut s'agir de l'un des éléments 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 à l'origine de la demande
teacherId

string

Limite les cours renvoyés à ceux ayant un enseignant avec l'identifiant spécifié. Il peut s'agir de l'un des éléments 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 à l'origine de la demande
courseStates[]

enum (CourseState)

Limite les cours affichés à ceux associés à 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é" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer un nombre de résultats inférieur au 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 lors de la création d'une liste de 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 demande de liste.
nextPageToken

string

Jeton identifiant la page suivante de résultats à renvoyer. Si ce champ n'est pas renseigné, 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.