Method: courses.list

Restituisce un elenco di corsi che l'utente richiedente è autorizzato a visualizzare, limitato a quelli che corrispondono alla richiesta. I corsi restituiti sono ordinati in base all'ora di creazione, con i corsi creati più di recente visualizzati per primi.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED per errori di accesso.
  • INVALID_ARGUMENT se l'argomento della query non è in un formato corretto.
  • NOT_FOUND se alcuni utenti specificati negli argomenti della query non esistono.

Richiesta HTTP

GET https://classroom.googleapis.com/v1/courses

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
studentId

string

Limita i corsi restituiti a quelli che hanno uno studente con l'identificatore specificato. L'identificatore può essere uno dei seguenti:

  • l'identificatore numerico dell'utente
  • l'indirizzo email dell'utente
  • il valore letterale della stringa "me", che indica l'utente richiedente

Se specificato, teacherId deve essere vuoto.
teacherId

string

Limita i corsi restituiti a quelli che hanno un insegnante con l'identificatore specificato. L'identificatore può essere uno dei seguenti:

  • l'identificatore numerico dell'utente
  • l'indirizzo email dell'utente
  • il valore letterale della stringa "me", che indica l'utente richiedente

Se specificato, studentId deve essere vuoto.
courseStates[]

enum (CourseState)

Limita i corsi restituiti a quelli in uno degli stati specificati. Il valore predefinito è ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

Il numero massimo di elementi da restituire. Il valore zero o non specificato indica che il server può assegnare un valore massimo.

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

string

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

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

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta durante l'elenco dei corsi.

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

Rappresentazione JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Campi
courses[]

object (Course)

I corsi che corrispondono alla richiesta di elenco.
nextPageToken

string

Token che identifica la pagina dei risultati successiva da restituire. Se è vuoto, non sono disponibili altri 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 all'autorizzazione.