Method: userProfiles.guardians.list

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

Per elencare i tutori di tutti gli studenti di cui l'utente richiedente può visualizzare i tutori, utilizza il carattere letterale - per l'ID studente.

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 le informazioni sul tutore dello studente, se "-" è specificato come studentId e l'utente non è un amministratore di dominio, se i tutori non sono abilitati per il dominio in questione, se il filtro invitedEmailAddress è impostato da un utente che non è un amministratore di dominio 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 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}/guardians

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
studentId

string

Filtra i risultati in base allo studente a cui è collegato il 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 a cui l'utente che effettua la richiesta ha accesso.

Parametri di query

Parametri
invitedEmailAddress

string

Filtra i risultati in base all'indirizzo email a cui è stato inviato l'invito originale, che genera questo link per il tutore. Questo filtro può essere utilizzato solo dagli amministratori di dominio.
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 i tutori.

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

Rappresentazione JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Campi
guardians[]

object (Guardian)

I guardiani in questa pagina di risultati che hanno soddisfatto i criteri specificati nella richiesta.
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.me.readonly
  • 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.