Method: courses.aliases.list

Renvoie une liste d'alias pour un cours.

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

  • PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à accéder au cours ou en cas d'erreurs d'accès.
  • NOT_FOUND si le cours n'existe pas.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
courseId

string

Identifiant du cours. Il peut s'agir de l'identifiant attribué par Classroom ou d'un alias.

Paramètres de requête

Paramètres
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 liste des alias 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 
{
  "aliases": [
    {
      object (CourseAlias)
    }
  ],
  "nextPageToken": string
}
Champs
aliases[]

object (CourseAlias)

Alias de cours.
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.