- Richiesta HTTP
- Parametri del percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Prova!
Restituisce un elenco dei tutori che l'utente richiedente è autorizzato a visualizzare, limitato a quelli che corrispondono alla richiesta.
Per elencare i tutori per gli studenti per i quali l'utente richiedente può visualizzare i tutori, utilizza il carattere letterale -
come ID studente.
Questo metodo restituisce i seguenti codici di errore:
PERMISSION_DENIED
se viene specificato unstudentId
e l'utente richiedente non è autorizzato a visualizzare le informazioni sui tutori per lo 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
è impostato da un utente che non è un amministratore di dominio o per altri errori di accesso.INVALID_ARGUMENT
se viene specificato unstudentId
, ma il suo formato non è riconosciuto (non è un indirizzo email, néstudentId
dall'API, né la stringa letteraleme
). Può essere restituito anche se viene fornito un valorepageToken
non valido.NOT_FOUND
se viene specificato unstudentId
e il suo formato è riconosciuto, ma in Classroom non è stato memorizzato alcun record dello 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 ricerca
Parametri | |
---|---|
invitedEmailAddress |
Filtra i risultati in base all'indirizzo email a cui è stato inviato l'invito originale, generando 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 limite 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 si elencano 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 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.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 alle autorizzazioni.