Method: userProfiles.guardians.list

Restituisce un elenco dei tutori che l'utente che ha inviato la richiesta è autorizzato a visualizzare, limitato ai tutori che corrispondono alla richiesta.

Per elencare i tutori di uno studente per il quale l'utente che ha inviato la richiesta 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 ha inviato 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 è stato impostato da un utente che non è un amministratore di dominio o per altri errori di accesso.
  • INVALID_ARGUMENT se viene specificato un studentId, ma il relativo formato non può essere riconosciuto (non si tratta di un indirizzo email, né di un studentId dell'API, né della stringa letterale me). Può essere restituito anche se viene specificato un valore pageToken non valido.
  • NOT_FOUND se è specificato un studentId e il relativo formato può essere riconosciuto, ma Classroom non ha alcuna registrazione di quello 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
  • il valore letterale della stringa "me", che indica l'utente che ha inviato la richiesta
  • il valore letterale della stringa "-", che indica che è necessario restituire i risultati per tutti gli studenti per i quali l'utente che ha inviato la richiesta è autorizzato a visualizzare.

Parametri di query

Parametri
invitedEmailAddress

string

Filtra i risultati in base all'indirizzo email a cui è stato inviato l'invito originale, ottenendo 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 dei risultati successiva.

La richiesta list deve essere altrimenti identica a quella che ha generato questo token.
pageSize

integer

Numero massimo di articoli da restituire. Zero o non specificato indica che il server può assegnare un numero massimo.

Il server potrebbe restituire un numero di risultati inferiore a quello 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)

Tutori in questa pagina dei risultati che hanno soddisfatto i criteri specificati nella richiesta.
nextPageToken

string

Token che identifica la pagina successiva di risultati da restituire. Se viene lasciato 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.