REST Resource: courses.aliases

Ressource: CourseAlias

Autre identifiant d'un cours.

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

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

  • project: un alias de portée projet est visible par toute requête d'une application utilisant l'ID de projet de la Developer Console qui a créé l'alias. Il peut être créé par n'importe quel projet. Un alias de portée projet est souvent utilisé lorsqu'une application dispose d'identifiants alternatifs. Une valeur aléatoire peut également être utilisée pour éviter les cours en double en cas d'échec de la transmission, car une nouvelle tentative de requête renvoie ALREADY_EXISTS si une 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 souhaité de l'alias.

  • d:<name> indique un alias de portée de domaine. Exemple : d:math_101
  • p:<name> indique un alias de portée 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

 Renvoie la liste des alias d'un cours.