Method: userProfiles.guardianInvitations.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.

Une fois que le responsable parental aura accepté l'invitation, son state passera à COMPLETED et il commencera à recevoir des notifications pour les responsables parentaux. Une ressource Guardian est également créée pour représenter le responsable actif.

Les champs studentId et invitedEmailAddress doivent être définis dans l'objet de la requête. Si vous ne définissez pas ces champs ou si vous définissez d'autres champs dans la requête, une erreur s'affiche.

Cette méthode renvoie les codes d'erreur suivants:

  • PERMISSION_DENIED si l'utilisateur actuel n'est pas autorisé à gérer les représentants légaux, si le représentant légal en question a déjà refusé trop de demandes pour cet élève, si les représentants légaux ne sont pas activés pour le domaine en question ou en cas d'autres erreurs d'accès.
  • RESOURCE_EXHAUSTED si l'élève ou le représentant légal a dépassé la limite d'association avec un représentant légal.
  • INVALID_ARGUMENT si l'adresse e-mail du représentant légal n'est pas valide (par exemple, si elle est trop longue) ou si le format de la pièce d'identité de l'élève fourni ne peut pas être reconnu (il ne s'agit pas d'une adresse e-mail ni d'un userId de cette API). Cette erreur est également renvoyée si des champs en lecture seule sont définis ou si le champ state est défini sur une valeur autre que PENDING.
  • NOT_FOUND si le numéro d'élève fourni est valide, mais que Classroom ne dispose d'aucun enregistrement de cet élève.
  • ALREADY_EXISTS si une invitation de représentant légal est déjà en attente pour l'élève et que le invitedEmailAddress fourni correspond au compte Google d'un Guardian existant pour cet utilisateur.invitedEmailAddress

Requête HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
guardianInvitation.studentId

string

Numéro d'identification de l'étudiant (au format standard)

Corps de la requête

Le corps de la requête contient une instance de GuardianInvitation.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de GuardianInvitation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Pour en savoir plus, consultez le guide d'autorisation.