Method: userProfiles.guardianInvitations.list

Renvoie la liste des invitations de responsable parental que l'utilisateur à l'origine de la requête est autorisé à consulter, filtrée par 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 requête n'est pas autorisé à afficher les invitations aux représentants légaux pour cet élève, si "-" est spécifié 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 un pageToken ou un state non valide est fourni.
  • NOT_FOUND si un studentId est spécifié et que son format peut être 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

ID de l'élève dont les invitations aux représentants légaux doivent être renvoyées. L'identifiant peut être l'un des éléments suivants:

  • Identifiant numérique de l'utilisateur
  • l'adresse e-mail de l'utilisateur ;
  • le littéral de chaîne "me", qui indique l'utilisateur à l'origine de la requête
  • la valeur littérale de chaîne "-", qui indique que les résultats doivent être renvoyés pour tous les élèves pour lesquels l'utilisateur à l'origine de la requête est autorisé à afficher les invitations aux parents.

Paramètres de requête

Paramètres
invitedEmailAddress

string

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

enum (GuardianInvitationState)

Si ce paramètre est spécifié, 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.

La requête list doit être identique à celle qui a généré ce jeton.
pageSize

integer

Nombre maximal d'éléments à renvoyer. Une valeur nulle ou non spécifiée indique que le serveur peut attribuer une valeur maximale.

Le serveur peut renvoyer un nombre inférieur au nombre de résultats 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 liste des invitations de 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 responsable parental correspondant à la requête 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 d'autorisation.