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 vengono ordinati in base all'ora di creazione e vengono inseriti per primi quelli creati più di recente.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED per errori di accesso.
  • INVALID_ARGUMENT se il formato dell'argomento di query non è corretto.
  • 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 ricerca

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 che ha inviato 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
  • Il valore letterale della stringa "me", che indica l'utente che ha inviato la richiesta
courseStates[]

enum (CourseState)

Limita i corsi restituiti a quelli che si trovano in uno degli stati specificati. Il valore predefinito è ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
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 si elencano 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 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.