Method: userProfiles.guardianInvitations.list

Renvoie une liste d'invitations destinées aux représentants légaux que l'utilisateur à l'origine de la demande est autorisé à consulter, filtrées en fonction des paramètres fournis.

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

  • PERMISSION_DENIED si le studentId est spécifié, et que l'utilisateur à l'origine de la demande n'est pas autorisé à voir les invitations aux représentants légaux pour cet élève, si "-" est défini comme studentId et que l'utilisateur n'est pas un administrateur du domaine, 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 valeur 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). Peut également être renvoyé si une valeur pageToken ou state non valide est fournie.
  • NOT_FOUND si un élément studentId est spécifié et que son format est reconnu, mais que Classroom n'a aucune trace de cet élève.

Requête HTTP

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

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 les invitations destinées aux représentants légaux doivent être renvoyées. Il peut s'agir de l'un des éléments suivants:

  • l'identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • Le littéral de chaîne "me", indiquant l'utilisateur à l'origine de la demande
  • Le littéral de chaîne "-", indiquant que les résultats doivent être renvoyés pour tous les élèves que l'utilisateur à l'origine de la demande est autorisé à voir les invitations aux représentants légaux.

Paramètres de requête

Paramètres
invitedEmailAddress

string

Si cette option est spécifiée, seuls les résultats comportant le invitedEmailAddress spécifié sont renvoyés.
states[]

enum (GuardianInvitationState)

Si cette option est spécifiée, seuls les résultats avec les valeurs state spécifiées sont renvoyés. Sinon, les résultats avec une state de PENDING sont renvoyés.
pageToken

string

Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée.

Par ailleurs, la requête list doit être identique à celle qui a généré ce jeton.
pageSize

integer

Nombre maximal d'éléments à renvoyer. La valeur "zéro" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer un nombre de résultats inférieur au nombre spécifié.

Corps de la requête

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

Corps de la réponse

Réponse lors de la création de listes d'invitations destinées aux représentants légaux.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Champs
guardianInvitations[]

object (GuardianInvitation)

Invitations de représentants légaux correspondant à la demande de liste.
nextPageToken

string

Jeton identifiant la page suivante de résultats à renvoyer. Si ce champ n'est pas renseigné, aucun autre résultat n'est disponible.

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.