Method: userProfiles.guardianInvitations.patch

Modifica un invito al tutore.

Al momento, l'unica modifica valida è cambiare state da PENDING a COMPLETE. Ciò ha l'effetto di ritirare l'invito.

Questo metodo restituisce i seguenti codici di errore:

  • PERMISSION_DENIED se l'utente corrente non dispone dell'autorizzazione per gestire i tutori, se i tutori non sono attivati per il dominio in questione o per altri errori di accesso.
  • FAILED_PRECONDITION se il collegamento del tutore non è nello stato PENDING.
  • INVALID_ARGUMENT se il formato dell'ID studente fornito non è riconosciuto (non è un indirizzo email né un userId di questa API), se il GuardianInvitation passato ha un state diverso da COMPLETE o se modifica campi diversi da state.
  • NOT_FOUND se l'ID studente fornito è valido, ma Classroom non ha dati su questo studente oppure se il campo id non fa riferimento a un invito del tutore noto a Classroom.

Richiesta HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
studentId

string

L'ID dello studente di cui deve essere modificato l'invito al tutore.
invitationId

string

Il campo id dell'elemento GuardianInvitation da modificare.

Parametri di query

Parametri
updateMask

string (FieldMask format)

Maschera che identifica i campi del corso da aggiornare. Questo campo è obbligatorio per eseguire un aggiornamento. L'aggiornamento non va a buon fine se vengono specificati campi non validi. I seguenti campi sono validi:

  • state

Se impostato in un parametro di query, questo campo deve essere specificato come

updateMask=<field1>,<field2>,...

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di GuardianInvitation.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di GuardianInvitation.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Per ulteriori informazioni, consulta la Guida all'autorizzazione.