- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
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 lestudentId
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 commestudentId
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 valeurstudentId
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émentstudentId
de l'API ni de la chaîne littéraleme
). Peut également être renvoyé si une valeurpageToken
oustate
non valide est fournie.NOT_FOUND
si un élémentstudentId
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 |
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:
|
Paramètres de requête
Paramètres | |
---|---|
invitedEmailAddress |
Si cette option est spécifiée, seuls les résultats comportant le |
states[] |
Si cette option est spécifiée, seuls les résultats avec les valeurs |
pageToken |
Valeur Par ailleurs, la requête |
pageSize |
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 ( |
Champs | |
---|---|
guardianInvitations[] |
Invitations de représentants légaux correspondant à la demande de liste. |
nextPageToken |
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.