Method: courses.aliases.list

Restituisce un elenco di alias per un corso.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED se l'utente che ha inviato la richiesta non è autorizzato ad accedere al corso o per errori di accesso.
  • NOT_FOUND se il corso non esiste.

Richiesta HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
courseId

string

L'identificatore del corso. Questo identificatore può essere l'identificatore assegnato da Classroom o un alias.

Parametri di ricerca

Parametri
pageSize

integer

Numero massimo di articoli da restituire. Zero o non specificato indica che il server può assegnare un limite massimo.

Il server potrebbe restituire un numero di risultati inferiore a quello specificato.
pageToken

string

Valore nextPageToken restituito da una precedente chiamata list, che indica che deve essere restituita la pagina di risultati successiva.

La richiesta list deve essere comunque identica a quella che ha generato questo token.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta quando vengono elencati gli alias del corso.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "aliases": [
    {
      object (CourseAlias)
    }
  ],
  "nextPageToken": string
}
Campi
aliases[]

object (CourseAlias)

Gli alias del corso.
nextPageToken

string

Token che identifica la pagina successiva dei risultati da restituire. Se vuoto, non sono disponibili ulteriori risultati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Per ulteriori informazioni, consulta la Guida alle autorizzazioni.