REST Resource: courses.aliases

Ressource: CourseAlias

Autre identifiant pour un cours.

Un alias identifie un cours de manière unique. Il doit être unique dans l'un des champs d'application suivants:

  • domaine: un alias à l'échelle du domaine est visible par tous les utilisateurs du domaine du créateur de l'alias et ne peut être créé que par un administrateur de domaine. Un alias à l'échelle du domaine est souvent utilisé lorsqu'un cours est associé à un identifiant externe à Classroom.

  • projet: un alias à l'échelle du projet est visible pour toute requête provenant d'une application utilisant l'ID de projet de la console développeur ayant créé l'alias. Il peut être créé par n'importe quel projet. Un alias à l'échelle du projet est souvent utilisé lorsqu'une application possède d'autres identifiants. Vous pouvez également utiliser une valeur aléatoire pour éviter les formations en double en cas d'échec de la transmission, car une nouvelle tentative de requête renverra ALREADY_EXISTS si la précédente a réussi.

Représentation JSON 
{
  "alias": string
}
Champs
alias

string

Chaîne d'alias. Le format de la chaîne indique le champ d'application de l'alias souhaité.

  • d:<name> indique un alias à l'échelle du domaine. Exemple : d:math_101
  • p:<name> indique un alias à l'échelle du projet. Exemple : p:abc123

Ce champ ne doit pas comporter plus de 256 caractères.

Méthodes

create

 Crée un alias pour un cours.

delete

 Supprime un alias d'un cours.

list

 Affiche la liste des alias d'un cours.