- Richiesta HTTP
- Parametri percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Prova!
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 unstudentId
e l'utente che ha inviato la richiesta non è autorizzato a visualizzare le informazioni sul tutore dello studente, se"-"
è specificato comestudentId
e l'utente non è un amministratore di dominio, se i tutori non sono abilitati per il dominio in questione, se il filtroinvitedEmailAddress
è stato impostato da un utente che non è un amministratore di dominio o per altri errori di accesso.INVALID_ARGUMENT
se viene specificato unstudentId
, ma il relativo formato non può essere riconosciuto (non si tratta di un indirizzo email, né di unstudentId
dell'API, né della stringa letteraleme
). Può essere restituito anche se viene specificato un valorepageToken
non valido.NOT_FOUND
se è specificato unstudentId
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 |
Filtra i risultati in base allo studente a cui è collegato il tutore. L'identificatore può essere uno dei seguenti:
|
Parametri di query
Parametri | |
---|---|
invitedEmailAddress |
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 |
Valore La richiesta |
pageSize |
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 ( |
Campi | |
---|---|
guardians[] |
Tutori in questa pagina dei risultati che hanno soddisfatto i criteri specificati nella richiesta. |
nextPageToken |
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.