REST Resource: userProfiles.guardianInvitations

Risorsa: Invito tutore

Un invito a diventare il tutore di un determinato utente, inviato a un indirizzo email specifico.

Rappresentazione JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Campi
studentId

string

ID dello studente (in formato standard)
invitationId

string

Identificatore univoco per questo invito.

Sola lettura.
invitedEmailAddress

string

Indirizzo email a cui è stato inviato l'invito. Questo campo è visibile solo agli amministratori di dominio.
state

enum (GuardianInvitationState)

Lo stato in cui si trova l'invito.
creationTime

string (Timestamp format)

L'ora di creazione dell'invito.

Sola lettura.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Stato dell'invito di un tutore.

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Non deve mai essere restituito.
PENDING L'invito è attivo e in attesa di risposta.
COMPLETE L'invito non è più attivo. Potrebbe essere stata accettata, rifiutata, ritirata o potrebbe essere scaduta.

Metodi

create

 Crea un invito come tutore e invia un'email al tutore per chiedergli di confermare di essere il tutore dello studente.

get

 Restituisce un invito specifico come tutore.

list

 Restituisce un elenco di inviti ai tutori che l'utente richiedente è autorizzato a visualizzare, filtrato in base ai parametri specificati.

patch

 Modifica l'invito di un tutore.