Method: courses.list

Restituisce un elenco dei corsi che l'utente che ha inviato la richiesta è autorizzato a visualizzare, limitato a quelli che corrispondono alla richiesta. I corsi restituiti sono ordinati in base all'ora di creazione, a partire dal più recente creato.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED per gli errori di accesso.
  • INVALID_ARGUMENT se l'argomento della query non è valido.
  • NOT_FOUND se non esistono utenti specificati negli argomenti della query.

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 ai corsi con 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 che ha inviato la richiesta
teacherId

string

Limita i corsi restituiti ai corsi 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 che ha inviato la richiesta
courseStates[]

enum (CourseState)

Limita i corsi restituiti a uno degli stati specificati. Il valore predefinito è ATTIVO, ARCHIVIATO, PROVISIONATO, RIFIUTATO.
pageSize

integer

Numero massimo di articoli da restituire. Zero o non specificato indica che il server può assegnare un numero 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 dei risultati successiva.

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 quando elenca i 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)

Corsi che corrispondono alla richiesta di elenco.
nextPageToken

string

Token che identifica la pagina successiva di risultati da restituire. Se viene lasciato 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.