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 du domaine. Un alias à l'échelle du domaine est souvent utilisé lorsqu'un cours possède un identifiant externe à Classroom.

  • Projet: un alias à l'échelle d'un projet est visible pour toute requête d'une application qui utilise l'ID de projet de la Play Console qui a 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. 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 d'exécution d'une 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é des alias.

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

list

 Renvoie une liste d'alias pour un cours.