REST Resource: userProfiles.guardianInvitations

Risorsa: invito tutore

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

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 dell'invito.
creationTime

string (Timestamp format)

L'ora in cui è stato creato l'invito.

Sola lettura.

Un timestamp nel formato RFC3339 UTC "Zulu" 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 di un invito come 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 stato accettato, rifiutato, ritirato o potrebbe essere scaduto.

Metodi

create

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

get

 Restituisce un invito specifico per il tutore.

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.

patch

 Modifica l'invito di un tutore.