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

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

  • PERMISSION_DENIED si un studentId est spécifié et que l'utilisateur à l'origine de la demande n'est pas autorisé à afficher les invitations aux représentants légaux de cet élève, si "-" est défini comme studentId et que l'utilisateur n'est pas administrateur de domaine, 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). Peut également être renvoyé si une valeur pageToken ou state non valide est fournie.
  • NOT_FOUND si un studentId est spécifié et que son format est reconnu, mais que Classroom ne contient 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'identifiant de l'élève dont les invitations de représentants légaux doivent être renvoyées. Il peut s'agir de l'un des types d'identifiants 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 demandeur
  • Le littéral de chaîne "-", indiquant que les résultats doivent être renvoyés pour tous les élèves auxquels l'utilisateur à l'origine de la demande est autorisé à afficher les invitations aux représentants légaux

Paramètres de requête

Paramètres
invitedEmailAddress

string

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

enum (GuardianInvitationState)

Si une valeur est spécifiée, seuls les résultats avec les valeurs state spécifiées sont renvoyés. Sinon, les résultats avec un 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'articles à renvoyer. "0" ou "non spécifié" indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer moins de résultats que le 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 l'affichage des invitations 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 de résultats suivante à renvoyer. Si ce champ est vide, 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.