REST Resource: courses.aliases

Risorsa: CourseAlias

Identificatore alternativo per un corso.

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

  • dominio: un alias con ambito di 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 con ambito di dominio viene spesso utilizzato quando un corso ha un identificatore esterno a Classroom.

  • progetto: un alias basato sui progetti è visibile a qualsiasi richiesta proveniente da un'applicazione utilizzando l'ID progetto della Developer Console che ha creato l'alias e può essere creato da qualsiasi progetto. Un alias basato sui progetti viene spesso utilizzato quando un'applicazione ha identificatori alternativi. È possibile utilizzare un valore casuale anche per evitare corsi duplicati in caso di errori di trasmissione, poiché ritentando una richiesta restituirà ALREADY_EXISTS se una precedente è andata a buon fine.

Rappresentazione JSON 
{
  "alias": string
}
Campi
alias

string

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

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