REST Resource: userProfiles.guardianInvitations

Ressource: GuardianInvitation

Invitation à devenir le responsable 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

Numéro d'identification de l'étudiant (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 est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 à un représentant légal.

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

Méthodes

create

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

get

 Affiche une invitation spécifique pour un représentant légal.

list

 Renvoie la liste des invitations de responsable parental que l'utilisateur à l'origine de la requête est autorisé à consulter, filtrée par les paramètres fournis.

patch

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