Method: userProfiles.guardianInvitations.get

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

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

  • PERMISSION_DENIED si l'utilisateur à l'origine de la requête n'est pas autorisé à afficher les invitations aux représentants légaux pour l'élève identifié par studentId, 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.
  • INVALID_ARGUMENT si un studentId est spécifié, mais que son format ne peut pas être reconnu (il ne s'agit pas d'une adresse e-mail, ni d'un studentId de l'API, ni de la chaîne littérale me).
  • NOT_FOUND si Classroom ne trouve aucun enregistrement de l'élève donné ou invitationId. Peut également être renvoyé si l'élève existe, mais que l'utilisateur à l'origine de la requête n'a pas accès à cet élève.

Requête HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
studentId

string

ID de l'élève dont l'invitation de représentant légal est demandée.
invitationId

string

Champ id de l'GuardianInvitation demandé.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

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

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

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