REST Resource: userProfiles.guardianInvitations

Risorsa: GuardianInvitation

Un invito a diventare il tutore di un utente specificato, 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

L'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 questo invito.

Sola lettura.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

GuardianInvitationState

Stato di un invito per un tutore.

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Non deve mai essere restituito.
PENDING L'invito è attivo e in attesa di una risposta.
COMPLETE L'invito non è più attivo. Potrebbe essere stato accettato, rifiutato, ritirato o essere scaduto.

Metodi

create

 Crea un invito per il tutore e gli invia un'email in cui gli viene chiesto di confermare di essere il tutore dello studente.

get

 Restituisce un invito per tutore specifico.

list

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

patch

 Modifica un invito per un tutore.