Table of contents
TOC
Réduire la table des matières
Développer la table des matières
Dernière mise à jour: 25/07/2018

Référence de l'API REST Étudiants

S'applique à : Office 365 Éducation

Cette documentation couvre des fonctionnalités actuellement en préversion.

Les API Office 365 Éducation permettent d'extraire des données à partir de votre client Office 365 bénéficiant d'une synchronisation cloud grâce à Microsoft School Data Sync. Les résultats fournis contiennent des informations concernant les écoles, les classes, les enseignants, les étudiants et les effectifs. L'API REST Étudiants permet d'accéder aux entités étudiants dans des clients Office 365 Éducation.

L'API repose sur Microsoft Azure Active Directory et OAuth pour authentifier les demandes de l'application.

Pour accéder à l'API REST Étudiants à partir de votre application, vous devez l'enregistrer dans Azure Active Directory. Vous devez également gérer les jetons d'authentification et créer l'URL et les requêtes appropriées. Les exemples ci-dessous peuvent être utilisés pour faciliter la construction de vos requêtes.

Test des API

Toutes les API pour les effectifs de l'école peuvent être testées dans un client EDU en utilisantl'Afficheur Graph. Accédez à l'afficheur Graph, utilisez vos informations d'identification pour vous connecter à votre client O365 EDU, sélectionnez la version « bêta » et copiez/collez les URL avant de vérifier la réponse.

Toutes les opérations de l'API REST Étudiants

Les étudiants sont représentés comme des utilisateurs dans Azure Active Directory. Vous pouvez obtenir des informations concernant l'étudiant actuellement connecté, ainsi que l'école et les classes auxquelles l'étudiant appartient.

Obtenir l'utilisateur actuel | Obtenir l'école d'un étudiant | Obtenir la section d'un étudiant

Utiliser l'API REST Étudiants

Pour interagir avec l'API REST Étudiants, vous envoyez des requêtes HTTP GET.

Si l'utilisateur connecté est un étudiant, toutes les demandes d'API REST Étudiants utilisent l'URL racine suivante :

https://graph.microsoft.com/beta/me/

Les étudiants sont représentés dans Azure Active Directory en tant qu'utilisateurs. Les attributs d'extension sur les utilisateurs permettent d'ajouter des informations spécifiques à l'étudiant.
Par exemple, l'attribut extension_fe2174665583431c953114ff7268b7b3_Education_Grade contient la note de l'étudiant.

Attributs d'étudiant

La description des attributs qui aident à identifier les informations sur l'étudiant se trouve sur : Attributs des étudiants


Obtenir l'utilisateur actuel

Vous pouvez obtenir l'utilisateur connecté et vérifier si cet utilisateur est un étudiant.

GET https://graph.microsoft.com/beta/me/

Type de réponse

L'utilisateur actuellement connecté.

Est-ce un étudiant

Un utilisateur actuellement connecté peut être un étudiant, un enseignant ou un utilisateur hors éducation (par exemple, le personnel administratif). Vous pouvez vérifier si l'utilisateur est un étudiant dans votre application. Requête pour l'attribut d'extension Education_ObjectType égal à Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'

Obtenir l'école d'un étudiant

Les écoles sont représentées dans Azure Active Directory en tant qu'Unités administratives. Les attributs d'extension de ces unités administratives ajoutent des informations spécifiques à l'école. Par exemple, l'attribut extension_fe2174665583431c953114ff7268b7b3_Education_HighestGrade contient la note la plus élevée pour cette école.

Vous pouvez obtenir l'école de l'étudiant connecté en obtenant l'appartenance de cet étudiant et en filtrant sur le extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'School' et objectType == 'AdministrativeUnit'

Obtenir l'appartenance de l'étudiant

Vous pouvez obtenir l'appartenance de l'étudiant connecté en utilisant la requête ci-dessous.

GET https://graph.microsoft.com/beta/me/

Type de réponse

La réponse inclura plusieurs groupes, DirectoryRoles et/ou AdministrativeUnits dont l'étudiant est membre.

Filtrer pour l'école

Vous pouvez obtenir l'école d'un étudiant en filtrant sur extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'School' et objectType == 'AdministrativeUnit'.


Obtenir la section d'un étudiant

Les classes sont représentées dans Azure Active Directory en tant que Groupes unifiés. Les attributs d'extension sur les groupes unifiés ajoutent des informations spécifiques aux sections. Par exemple, l'attribut extension_fe2174665583431c953114ff7268b7b3_Education_CourseName contient le nom du cours pour cette section.

Obtenir l'appartenance de l'étudiant

Vous pouvez obtenir l'appartenance de l'étudiant en utilisant la requête ci-dessous.

GET https://graph.microsoft.com/beta/me/

Type de réponse

La réponse inclura plusieurs groupes, DirectoryRoles et/ou AdministrativeUnits dont l'étudiant est membre.

Filtrer sur la section

Vous pouvez obtenir la section d'un étudiant en filtrant sur extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Section' et objectType == 'Group'.


Étapes suivantes

Voici quelques ressources éducatives qui pourraient également vous intéresser

Que vous soyez prêt à développer une application ou que vous souhaitiez simplement en savoir plus, nous avons ce qu'il vous faut.

Ou pour en savoir plus sur l'utilisation de la plate-forme Office 365 :

© 2018 Microsoft