Method: invitations.list

Restituisce un elenco di inviti che l'utente richiedente è autorizzato a visualizzare, limitato agli inviti che corrispondono alla richiesta di elenco.

Nota: è necessario specificare almeno uno dei seguenti valori: userId o courseId. È possibile compilare 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 ricerca

Parametri
userId

string

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

string

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

integer

Numero massimo di articoli da restituire. Il valore predefinito è 500 se non specificato o 0.

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 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 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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

Per ulteriori informazioni, consulta la Guida alle autorizzazioni.