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 Écoles

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 proposent des informations concernant les écoles, les classes, les enseignants, les étudiants et les effectifs. L'API REST Écoles permet d'accéder aux entités écoles 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 Écoles à 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 vous assister dans la construction de vos requêtes.

Opérations de l'API REST Écoles

Les écoles sont représentées en tant qu'unités administratives au sein d'Azure Active Directory. Vous pouvez obtenir les écoles disponibles dans un client, ainsi que les classes, les étudiants et les enseignants appartenant à chaque entité scolaire.

Obtenir des écoles | Obtenir les classes d'une école | Obtenir les étudiants d'une école | Obtenir les enseignants d'une école

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.

Utiliser l'API REST Écoles

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

Toutes les demandes à l'API REST Écoles utilisent l'URL racine suivante :

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

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 éducatives spécifiques.
Par exemple, l'attribut extension_fe2174665583431c953114ff7268b7b3_Education_HighestGrade contient le niveau le plus élevé au sein de l'école.

Remarque Toutes les demandes doivent mentionner « beta » dans l'URL.

Attributs d'école

La description des attributs qui permettent d'identifier les informations propres à une école est consultable dans l'article : Attributs d'écoles


Obtenir des écoles

Vous pouvez obtenir l'ensemble des écoles, une seule école identifiée par son id ou une série d'écoles correspondant à un certain nombre de filtres de requête.

Obtenir l'ensemble des écoles

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

https://graph.microsoft.com/beta/administrativeUnits/?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'School'

Type de réponse

Une collection d'entités scolaires.


Obtenir une école

Obtenez une école en utilisant son id.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}
Paramètre requisTypeDescription
Paramètres d'URL
idchaîneL'ID de l'unité administrative scolaire dans Azure Active Directory.

Type de réponse

L'entité scolaire demandée.


Obtenir les classes d'une école

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

Vous pouvez obtenir les classes d'une école spécifique en effectuant une requête de groupes basée sur leur ID d'école. Vous utilisez alors les attributs extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType et extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId au sein de la requête.

GET  https://graph.microsoft.com/beta/groups?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Section'%20and%20extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId%20eq%20'10002'
Paramètre requisTypeDescription
Paramètres d'URL
school_idchaîneL'ID de l'école au sein du SIS (système d'information scolaire) fourni par la requête d'obtention d'écoles

Type de réponse

Une collection d'entités de sections.


Obtenir les étudiants d'une école

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. L'attribut extension_fe2174665583431c953114ff7268b7b3_Education_Grade contient par exemple le niveau de l'étudiant.

Vous pouvez obtenir des étudiants d'une école spécifique en obtenant l'ensemble des membre de l'unité administrative scolaire, puis en filtrant dans votre application les utilisateurs non-étudiants de la collection.

Obtenir les membres d'une école

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Paramètre requisTypeDescription
Paramètres d'URL
idchaîneL'ID de l'unité administrative scolaire 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. Cherchez l'attribut d'extension Education_ObjectType égal à Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'
GET https://graph.microsoft.com/beta/administrativeUnits/<GUID_AAD_ID_OF_SCHOOL_AU>/members/$/microsoft.graph.user?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Student'

Obtenir les enseignants d'une école

Les enseignants 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'enseignant. L'attribut extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber contient par exemple le numéro d'enseignant.

Vous pouvez obtenir des enseignants d'une école spécifique en obtenant l'ensemble des membre de l'unité administrative scolaire, puis en filtrant dans votre application les utilisateurs non-enseignants de la collection.

Obtenir les membres d'une école

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Paramètre requisTypeDescription
Paramètres d'URL
idchaîneL'ID de l'unité administrative scolaire 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. Cherchez l'attribut d'extension Education_ObjectType égal à Teacher.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Teacher'
GET https://graph.microsoft.com/beta/administrativeUnits/<GUID_AAD_ID_OF_SCHOOL_AU>/members/$/microsoft.graph.user?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'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