Method: courses.list

Restituisce un elenco di corsi che l'utente che effettua la richiesta può visualizzare, limitato a quelli corrispondenti alla richiesta. I corsi restituiti sono ordinati in base alla data di creazione, con il corso creato più di recente in primo piano.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED per errori di accesso.
  • INVALID_ARGUMENT se l'argomento della query non è valido.
  • NOT_FOUND se gli 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 con uno studente con l'identificatore specificato. L'identificatore può essere uno dei seguenti:

  • l'identificatore numerico dell'utente
  • l'indirizzo email dell'utente
  • la stringa letterale "me", che indica l'utente che effettua la richiesta
teacherId

string

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

  • l'identificatore numerico dell'utente
  • l'indirizzo email dell'utente
  • la stringa letterale "me", che indica l'utente che effettua la richiesta
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. Zero o non specificato indica che il server può assegnare un valore massimo.

Il server potrebbe restituire meno del numero di risultati specificato.
pageToken

string

Valore nextPageToken restituito da una chiamata list precedente, che indica che deve essere restituita la pagina di 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 vengono elencati 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 corrispondenti alla richiesta di elenco.
nextPageToken

string

Token che identifica la pagina di 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.