Method: userProfiles.guardianInvitations.list

Restituisce un elenco di inviti per i tutori che l'utente che ha inviato la richiesta è autorizzato a visualizzare, filtrato in base ai parametri forniti.

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 gli inviti dei tutori 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 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 o state 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}/guardianInvitations

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
studentId

string

Il documento di identità dello studente di cui deve essere restituito l'invito come 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 gli inviti per i tutori.

Parametri di query

Parametri
invitedEmailAddress

string

Se specificato, vengono restituiti solo i risultati con il valore invitedEmailAddress specificato.
states[]

enum (GuardianInvitationState)

Se specificato, vengono restituiti solo i risultati con i valori state specificati. In caso contrario, vengono restituiti i risultati con state pari a PENDING.
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 gli inviti dei tutori.

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

Rappresentazione JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Campi
guardianInvitations[]

object (GuardianInvitation)

Inviti a tutori che corrispondono alla richiesta di elenco.
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.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Per ulteriori informazioni, consulta la Guida all'autorizzazione.