- 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 la liste des représentants légaux que l'utilisateur à l'origine de la requête est autorisé à consulter, limitée à ceux qui correspondent à la requête.
Pour lister les représentants légaux de tous les élèves que l'utilisateur à l'origine de la requête peut consulter, utilisez le caractère littéral -
pour l'ID de l'élève.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED
si unstudentId
est spécifié et que l'utilisateur à l'origine de la requête n'est pas autorisé à consulter les informations sur les représentants légaux de cet élève, si"-"
est spécifié commestudentId
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, si le filtreinvitedEmailAddress
est défini par un utilisateur qui n'est pas administrateur de domaine ou pour d'autres erreurs d'accès.INVALID_ARGUMENT
si unstudentId
est spécifié, mais que son format ne peut pas être reconnu (il ne s'agit pas d'une adresse e-mail, ni d'unstudentId
de l'API, ni de la chaîne littéraleme
). Peut également être renvoyé si unpageToken
non valide est fourni.NOT_FOUND
si unstudentId
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}/guardians
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
student |
Filtrez les résultats en fonction de l'élève auquel le représentant légal est associé. L'identifiant peut être l'un des éléments suivants:
|
Paramètres de requête
Paramètres | |
---|---|
invited |
Filtrez les résultats en fonction de l'adresse e-mail à laquelle l'invitation d'origine a été envoyée, ce qui a généré ce lien de responsabilité parentale. Ce filtre ne peut être utilisé que par les administrateurs de domaine. |
page |
Valeur La requête |
page |
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 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 |
---|
{
"guardians": [
{
object ( |
Champs | |
---|---|
guardians[] |
Les résultats de cette page correspondent aux résultats qui répondent aux critères spécifiés dans la requête. |
next |
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.me.readonly
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.