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 Enseignants

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 Enseignants permet d'accéder aux entités enseignants dans 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 Enseignants à partir de votre application, vous devez l'enregistrer dans Azure Active Directory. Vous devez également gérer les jetons d'authentification, ainsi que créer l'URL et les requêtes appropriées pour répondre à vos besoins. 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 à Afficheur Graph, connectez-vous avec vos informations d'identification de client hébergé O365 EDU, sélectionnez « version bêta » comme version et copiez/collez les URL puis vérifiez la réponse.

Toutes les opérations de l'API REST Enseignants

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

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

Utiliser l'API REST Enseignants

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

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

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

Les enseignants sont représentés dans Azure Active Directory en tant qu'utilisateurs. Les attributs d'extension sur les utilisateurs ajoutent des informations spécifiques à l'enseignant.
Par exemple, l'attribut extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber contient le numéro d'enseignant de l'enseignant.

Attributs d'enseignant

La description des attributs qui aident à identifier les informations sur l'enseignant se trouve à : Attributs de l'enseignant


Obtenir l'utilisateur actuel

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

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

Type de réponse

L'utilisateur actuellement connecté.

Vérifier s'il s'agit d'un enseignant

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 enseignant dans votre application. Cherchez l'attribut d'extension Education_ObjectType égal à Teacher.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Teacher'

Obtenir l'école d'un enseignant

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'enseignant connecté en obtenant l'appartenance de cet enseignant et en filtrant sur le extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'School' et objectType == 'AdministrativeUnit'

Obtenir l'appartenance de l'enseignant

Vous pouvez obtenir l'appartenance de l'enseignant 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'enseignant est membre.

Filtrer pour l'école

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


Obtenir la section d'un enseignant

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 spécifiques aux sections. Par exemple, l'attribut extension_fe2174665583431c953114ff7268b7b3_Education_CourseName contient le nom du cours pour la section.

Obtenir l'appartenance de l'enseignant

Vous pouvez obtenir l'appartenance de l'enseignant 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'enseignant est membre.

Filtrer sur la section

Vous pouvez obtenir la section d'un enseignant 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