REST Resource: userProfiles.guardianInvitations

Ressource : GuardianInvitation

Invitation à devenir le représentant légal d'un utilisateur spécifié, envoyée à une adresse e-mail spécifiée.

Représentation JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Champs
studentId

string

ID de l'élève (au format standard)
invitationId

string

Identifiant unique de cette invitation.

Lecture seule.
invitedEmailAddress

string

Adresse e-mail à laquelle l'invitation a été envoyée. Ce champ n'est visible que par les administrateurs de domaine.
state

enum (GuardianInvitationState)

État de l'invitation.
creationTime

string (Timestamp format)

Heure à laquelle cette invitation a été créée.

Lecture seule.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

GuardianInvitationState

État d'une invitation envoyée à un représentant légal.

Enums
GUARDIAN_INVITATION_STATE_UNSPECIFIED Ne doit jamais être renvoyé.
PENDING L'invitation est active et en attente de réponse.
COMPLETE L'invitation n'est plus active. Il est possible qu'elle ait été acceptée, refusée, retirée ou qu'elle ait expiré.

Méthodes

create

 Crée une invitation pour un représentant légal et lui envoie un e-mail lui demandant de confirmer qu'il est le représentant légal de l'élève.

get

 Renvoie une invitation spécifique envoyée à un représentant légal.

list

 Renvoie une liste des invitations de représentants légaux que l'utilisateur à l'origine de la requête est autorisé à consulter, filtrée selon les paramètres fournis.

patch

 Modifie une invitation envoyée à un représentant légal.