REST Resource: courses.aliases

Risorsa: CourseAlias

Identificatore alternativo per un corso.

Un alias identifica in modo univoco un corso. Deve essere univoco in uno dei seguenti ambiti:

  • domain: un alias basato sul dominio è visibile a tutti gli utenti all'interno del dominio del creatore dell'alias e può essere creato solo da un amministratore di dominio. Un alias a livello di dominio viene spesso utilizzato quando un corso ha un identificatore esterno a Classroom.

  • project: un alias basato sul progetto è visibile a qualsiasi richiesta di un'applicazione che utilizza l'ID progetto di Developer Console che ha creato l'alias e può essere creato da qualsiasi progetto. Un alias a livello di progetto viene spesso utilizzato quando un'applicazione ha identificatori alternativi. Un valore casuale può essere utilizzato anche per evitare corsi duplicati in caso di errori di trasmissione, poiché il nuovo tentativo di invio di una richiesta restituirà ALREADY_EXISTS se una precedente è andata a buon fine.

Rappresentazione JSON 
{
  "alias": string
}
Campi
alias

string

Stringa dell'alias. Il formato della stringa indica l'ambito dell'alias desiderato.

  • d:<name> indica un alias a livello di dominio. Esempio: d:math_101
  • p:<name> indica un alias a livello di progetto. Esempio: p:abc123

Questo campo ha una lunghezza massima di 256 caratteri.

Metodi

create

 Crea un alias per un corso.

delete

 Consente di eliminare un alias di un corso.

list

 Restituisce un elenco di alias per un corso.