Method: userProfiles.guardianInvitations.list

Restituisce un elenco di inviti per i tutori che l'utente che effettua la richiesta può visualizzare, filtrato in base ai parametri forniti.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED se è specificato un studentId e l'utente che effettua la richiesta non è autorizzato a visualizzare gli inviti ai tutori per lo studente, se "-" è specificato come studentId e l'utente non è un amministratore di dominio, se i tutori non sono abilitati per il dominio in questione o per altri errori di accesso.
  • INVALID_ARGUMENT se è specificato un studentId, ma il relativo formato non può essere riconosciuto (non è un indirizzo email, né un studentId dell'API né la stringa letterale me). Può essere restituito anche se viene fornito un pageToken o un state non valido.
  • NOT_FOUND se è specificato un studentId e il relativo formato può essere riconosciuto, ma Classroom non ha dati su questo studente.

Richiesta HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
studentId

string

L'ID dello studente di cui devono essere restituiti gli inviti al tutore. 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
  • la stringa letterale "-", che indica che i risultati devono essere restituiti per tutti gli studenti per i quali l'utente che effettua la richiesta è autorizzato a visualizzare gli inviti dei tutori.

Parametri di query

Parametri
invitedEmailAddress

string

Se specificato, vengono restituiti solo i risultati con il invitedEmailAddress specificato.
states[]

enum (GuardianInvitationState)

Se specificato, vengono restituiti solo i risultati con i valori state specificati. In caso contrario, vengono restituiti risultati con un state di PENDING.
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.
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.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta quando vengono elencati gli inviti per i tutori.

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

Rappresentazione JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Campi
guardianInvitations[]

object (GuardianInvitation)

Inviti di tutori 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.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Per ulteriori informazioni, consulta la Guida all'autorizzazione.