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:

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

  • progetto: un alias con ambito a livello di progetto è visibile a tutte le richieste di un'applicazione che utilizzano l'ID progetto della Console per gli sviluppatori che ha creato l'alias e può essere creato da qualsiasi progetto. Un alias con ambito a livello di progetto viene spesso utilizzato quando un'applicazione dispone di identificatori alternativi. È possibile usare un valore casuale anche per evitare corsi duplicati in caso di errori di trasmissione, poiché un nuovo tentativo di richiesta restituirà ALREADY_EXISTS se una precedente ha avuto esito positivo.

Rappresentazione JSON 
{
  "alias": string
}
Campi
alias

string

Stringa alias. Il formato della stringa indica la definizione dell'ambito dell'alias desiderata.

  • d:<name> indica un alias basato sul dominio. Esempio: d:math_101
  • p:<name> indica un alias con ambito 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

 Elimina l'alias di un corso.

list

 Restituisce un elenco di alias per un corso.