Method: userProfiles.guardianInvitations.get

Renvoie une invitation à un représentant légal spécifique.

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

  • PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à voir les invitations au représentant légal pour l'élève identifié par le studentId, si les représentants légaux ne sont pas activés pour le domaine en question ou en cas d'erreur d'accès.
  • INVALID_ARGUMENT si une studentId est spécifiée, mais que son format n'est pas reconnu (il ne s'agit pas d'une adresse e-mail, d'un élément studentId de l'API ni de la chaîne littérale me).
  • NOT_FOUND si Classroom ne trouve aucun enregistrement de l'élève ou du invitationId donné. Cette valeur peut également être renvoyée si l'élève existe, mais que l'utilisateur à l'origine de la demande n'est pas autorisé à le voir.

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

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

string

Champ id du 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 relatif aux autorisations.