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 ( |
Champs | |
---|---|
student |
Numéro d'identification de l'étudiant (au format standard) |
invitation |
Identifiant unique de cette invitation. Lecture seule. |
invited |
Adresse e-mail à laquelle l'invitation a été envoyée. Ce champ n'est visible que par les administrateurs de domaine. |
state |
État de l'invitation. |
creation |
Heure à laquelle cette invitation a été créée. Lecture seule. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
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 en attente de 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 |
|
---|---|
|
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. |
|
Renvoie une invitation de responsable spécifique. |
|
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. |
|
Modifie une invitation de représentant légal. |