- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Prova!
Crea un invito al tutore e invia un'email al tutore chiedendo di confermare di essere il tutore dello studente.
Una volta accettato l'invito, il suo state
diventerà COMPLETED
e inizierà a ricevere notifiche per i tutori. Verrà inoltre creata una risorsa Guardian
per rappresentare il tutore attivo.
L'oggetto request deve avere i campi studentId
e invitedEmailAddress
impostati. La mancata impostazione di questi campi o l'impostazione di altri campi nella richiesta comporterà un errore.
Questo metodo restituisce i seguenti codici di errore:
PERMISSION_DENIED
se l'utente corrente non dispone dell'autorizzazione per gestire i tutori, se il tutore in questione ha già rifiutato troppe richieste per lo studente, se i tutori non sono abilitati per il dominio in questione o per altri errori di accesso.RESOURCE_EXHAUSTED
se lo studente o il tutore ha superato il limite di collegamento dei tutori.INVALID_ARGUMENT
se l'indirizzo email del tutore non è valido (ad esempio se è troppo lungo) o se non è possibile riconoscere il formato dell'ID studente fornito (non è un indirizzo email né unuserId
di questa API). Questo errore viene restituito anche se sono impostati campi di sola lettura o se il campostate
è impostato su un valore diverso daPENDING
.NOT_FOUND
se l'ID studente fornito è valido, ma Classroom non ha dati su questo studente.ALREADY_EXISTS
se esiste già un invito al tutore in attesa per lo studente e per ilinvitedEmailAddress
fornito oppure se ilinvitedEmailAddress
fornito corrisponde all'Account Google di unGuardian
esistente per questo utente.
Richiesta HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
guardian |
ID dello studente (in formato standard) |
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
appena creata.
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Per ulteriori informazioni, consulta la Guida all'autorizzazione.