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'étudiant (au format standard)
invitationId

string

Identifiant unique de cette invitation.

En lecture seule.
invitedEmailAddress

string

Adresse e-mail à laquelle l'invitation a été envoyée. Seuls les administrateurs du domaine peuvent voir ce champ.
state

enum (GuardianInvitationState)

État dans lequel se trouve cette invitation.
creationTime

string (Timestamp format)

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

En 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 : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

État d'une invitation destinée au 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 a peut-être expiré, été accepté, refusé ou retiré.

Méthodes

create

 L'élève crée une invitation à devenir représentant légal, puis lui envoie un e-mail pour lui demander de confirmer qu'il s'agit bien du tuteur légal de l'élève.

get

 Renvoie une invitation spécifique au représentant légal.

list

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

patch

 Modifie l'invitation du représentant légal.