Method: invitations.list

Restituisce un elenco di inviti che l'utente che effettua la richiesta può visualizzare, limitato a quelli corrispondenti alla richiesta dell'elenco.

Nota: è necessario specificare almeno uno tra userId o courseId. È possibile fornire entrambi i campi.

Questo metodo restituisce i seguenti codici di errore:

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
userId

string

Limita gli inviti restituiti a quelli per un utente specifico. 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
courseId

string

Limita gli inviti restituiti a quelli per un corso con l'identificatore specificato.
pageSize

integer

Il numero massimo di elementi da restituire. Il valore predefinito è 500 se non specificato o 0.

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 gli inviti.

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

Rappresentazione JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ],
  "nextPageToken": string
}
Campi
invitations[]

object (Invitation)

Inviti corrispondenti alla richiesta dell'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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

Per ulteriori informazioni, consulta la Guida all'autorizzazione.