- Richiesta HTTP
- Parametri del percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Prova!
Restituisce un elenco di inviti ai tutori che l'utente richiedente è autorizzato a visualizzare, filtrato in base ai parametri specificati.
Questo metodo restituisce i seguenti codici di errore:
PERMISSION_DENIED
se viene specificato unstudentId
e l'utente richiedente non è autorizzato a visualizzare gli inviti dei tutori per quello studente, se"-"
è specificato comestudentId
e l'utente non è un amministratore di dominio, se i tutori non sono abilitati per il dominio in questione o se i tutori non sono abilitati per il dominio in questione 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
ostate
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}/guardianInvitations
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
studentId |
L'ID dello studente di cui devono essere restituiti gli inviti al tutore. L'identificatore può essere uno dei seguenti:
|
Parametri di ricerca
Parametri | |
---|---|
invitedEmailAddress |
Se specificato, vengono restituiti solo i risultati con il valore |
states[] |
Se specificato, vengono restituiti solo i risultati con i valori |
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 vengono elencati gli inviti dei tutori.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"guardianInvitations": [
{
object ( |
Campi | |
---|---|
guardianInvitations[] |
Inviti a tutori corrispondenti alla richiesta di elenco. |
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.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Per ulteriori informazioni, consulta la Guida alle autorizzazioni.