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 Sections

Concerne : 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 proposent des informations concernant les écoles, les classes, les enseignants, les étudiants et les effectifs. Chaque classe de l'école est représentée en tant que section. L'API REST Sections permet d'accéder aux sections dans les clients Office 365 Éducation.

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

Pour accéder à l'API REST Sections à 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 en accord avec vos besoins. Les exemples ci-dessous peuvent être utilisés pour faciliter la construction de vos requêtes.

Toutes les opérations de l'API REST Sections

Les sections sont représentées comme des groupes unifiés dans Azure Active Directory. Vous pouvez obtenir les classes disponibles dans un client, ainsi que les étudiants et les enseignants appartenant à chaque classe, ainsi que les informations propres à l'école à laquelle appartient la classe.

Obtenez des sections | Obtenez l'école d'une section | Obtenez les étudiants d'une section | Obtenez les enseignants d'une section

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.

Utilisez l'API REST Sections

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

Toutes les requêtes à l'API REST Sections utilisent l'URL racine suivante :

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

Les sections 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 propres à l'éducation.
Par exemple, l'attribut extension_fe2174665583431c953114ff7268b7b3_Education_CourseNumber contient le numéro de cours d'une section.

Attributs de section

La description des attributs qui aident à identifier les informations concernant la section se trouve ici : Attributs de section


Obtenir les sections

Vous pouvez obtenir toutes les sections, obtenir une seule section par son idou obtenir une collection de sections correspondant à un ensemble de filtres de requête.

Obtenir toutes les sections

Obtenez toutes les sections présentes dans le client Azure Active Directory.

GET https://graph.microsoft.com/beta/groups?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Section'

Type de réponse

Une collection d'entités de sections.


Obtenez une section

Obtenez une section en utilisant le id.

GET https://graph.microsoft.com/beta/groups/{id}
Paramètre requisTypeDescription
Paramètres d'URL
idchaîneL'identifiant du groupe de sections dans Azure Active Directory.

Type de réponse

L'entité de section demandée.


Obtenez l'école d'une section

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 à laquelle une section est associée en interrogeant les unités administratives sur la propriété SchoolId obtenue de la réponse extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId de Obtenez une section.

GET https://graph.microsoft.com/administrativeUnits?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'School'%20
and%20extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId%20eq%20{school_id}
Paramètre requisTypeDescription
Paramètres d'URL
school_idchaîneL'identifiant de l'école dans le système d'information scolaire (SIS).

Type de réponse

Une entité scolaire.


Obtenez les étudiants d'une section

Les étudiants sont représentés dans Azure Active Directory en tant qu'utilisateurs. Les attributs d'extension utilisateur ajoutent des informations spécifiques aux étudiants. L'attribut extension_fe2174665583431c953114ff7268b7b3_Education_Grade contient par exemple le niveau de l'étudiant.

Vous pouvez obtenir les étudiants d'une section spécifique, en obtenant les membres du groupe unifié de la section et en filtrant les utilisateurs non-étudiants de la collection résultante au sein de votre application.

Obtenir les membres de la section

GET https://graph.microsoft.com/beta/groups/{id}/members
Paramètre requisTypeDescription
Paramètres d'URL
idchaîneL'identifiant du groupe de sections dans Azure Active Directory.

Type de réponse

Une collection d'utilisateurs.

Trouver les étudiants

Une collection d'utilisateurs peut contenir des étudiants, des enseignants et des utilisateurs non-liés à l'éducation (comme par exemple du personnel administratif). Vous pouvez filtrer les étudiants présents dans une collection au sein de votre application. Requête pour l'attribut d'extension Education_ObjectType égal à Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'

Obtenez les enseignants d'une section

Les enseignants sont représentés dans Azure Active Directory en tant qu'utilisateurs. Les attributs d'extension utilisateur ajoutent des informations spécifiques aux enseignants. L'attribut extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber contient par exemple le numéro d'enseignant.

Vous pouvez obtenir les étudiants d'une section spécifique, en obtenant les membres du groupe unifié de la section et en filtrant les utilisateurs non-étudiants de la collection résultante au sein de votre application.

Obtenir les membres de la section

GET https://graph.microsoft.com/beta/groups/{id}/members
Paramètre requisTypeDescription
Paramètres d'URL
tenant_idchaîneL'identifiant du client Azure Active Directory ou le nom de domaine.
idchaîneL'identifiant du groupe de sections dans Azure Active Directory.

Type de réponse

Une collection d'utilisateurs.

Trouver les enseignants

Une collection d'utilisateurs peut contenir des étudiants, des enseignants et des utilisateurs non-liés à l'éducation (comme par exemple du personnel administratif). Vous pouvez filtrer les enseignants présents dans une collection au sein de votre application. Requête pour l'attribut d'extension Education_ObjectType égal à Teacher.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Teacher'

É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