Method: userProfiles.guardianInvitations.list

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 un studentId e l'utente richiedente non è autorizzato a visualizzare gli inviti dei tutori per quello 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 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 suo formato non è riconosciuto (non è un indirizzo email, né studentId dall'API, né la stringa letterale me). Può essere restituito anche se viene fornito un valore pageToken o state non valido.
  • NOT_FOUND se viene specificato un studentId 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

string

L'ID dello studente di cui devono essere restituiti gli inviti al 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 "-", a indicare che devono essere restituiti i risultati per tutti gli studenti che l'utente richiedente è autorizzato a visualizzare gli inviti ai tutori.

Parametri di ricerca

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 risultati con un valore state pari a PENDING.
pageToken

string

Valore nextPageToken restituito da una precedente chiamata list, che indica che deve essere restituita la pagina di risultati successiva.

La richiesta list deve essere comunque 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 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 (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Campi
guardianInvitations[]

object (GuardianInvitation)

Inviti a tutori corrispondenti alla richiesta di elenco.
nextPageToken

string

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.