Table of contents
TOC
目次を折りたたむ
目次を展開する
最終更新日: 2018/07/25

学生 REST API リファレンス

適用対象: Office 365 Education

このドキュメントで取り上げる機能は、現時点ではプレビュー段階にあります。

Office 365 Education API は、Microsoft School Data Sync でクラウドに同期されている Office 365 テナントからデータを抽出する際に役立ちます。その結果には、教育機関、セクション、教師、学生および名簿に関する情報が含まれています。学生 REST API は、Education テナント用の Office 365 に含まれる学生エンティティへのアクセスを提供します。

API は Microsoft Azure Active Directory と OAuth を使用して、アプリケーション要求を認証します

アプリケーションから学生 REST API にアクセスするには、そのアプリケーションを Azure Active Directory に登録することが必要になります。また、認証トークンを管理し、ニーズを満たす正しい URL とクエリを構築する必要もあります。次に示す各例は、クエリを作成する際に利用できます。

API のテスト

Graph エクスプローラーを使用すると、EDU テナントですべての学校の名簿 API をテストできます。Graph エクスプローラーに移動し、O365 EDU テナントの資格情報を使用してサインインします。バージョンには「ベータ」を選択します。URL をコピーし、貼り付けて、応答を確認します。

すべての学生 REST API 操作

Azure Active Directory では、学生がユーザーとして表されます。ログインしている現在の学生の情報を取得できます。また、学生が属している教育機関とセクションも取得できます。

現在のユーザーを取得する | 学生の教育機関を取得する | 学生のセクションを取得する

学生 REST API の使用

学生 REST API と対話する場合は、HTTP GET 要求を送信します。

ログインしているユーザーが学生の場合、すべての学生 REST API 要求は次のルート URL を使用します。

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

Azure Active Directory では、学生がユーザーとして表されます。ユーザーについての拡張属性により、学生固有の情報が追加されます。
たとえば、extension_fe2174665583431c953114ff7268b7b3_Education_Grade 属性には学生の学年が格納されます。

学生の属性

学生に関する情報を特定する際に役立つ属性の説明については、「学生の属性」をご覧ください


現在のユーザーの取得

現在ログインしているユーザーを取得し、そのユーザーが学生かどうかを確認することができます。

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

応答の種類

現在ログインしているユーザー。

学生であることの確認

現在ログインしているユーザーは、学生、教職員、または教育に関わらない (管理スタッフなどの) ユーザーである可能性があります。ユーザーが学生であるかどうかは、アプリケーションで確認できます。Student と等しくなる Education_ObjectType 拡張属性についてのクエリを実行します。

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'

学生の教育機関の取得

Azure Active Directory では、教育機関が管理単位として表されます。これに該当する管理単位の拡張属性により、教育機関固有の情報が追加されます。たとえば、extension_fe2174665583431c953114ff7268b7b3_Education_HighestGrade 属性には、その教育機関の最高学年が格納されています。

ログインしている学生の教育機関は、その学生のメンバーシップを取得して、extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'School'objectType == 'AdministrativeUnit' に対するフィルターを適用することで取得できます。

学生のメンバーシップの取得

ログインしている学生のメンバーシップは、次に示すクエリを使用することで取得できます。

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

応答の種類

応答には、学生がメンバーになっている複数の Group や DirectoryRole、AdministrativeUnit が含まれています。

教育機関のフィルター

学生の教育機関は、extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'School'objectType == 'AdministrativeUnit' に関するフィルター処理によって取得できます。


学生のセクションの取得

Azure Active Directory では、セクションが統合グループとして表されます。統合グループについての拡張属性により、セクション固有の情報が追加されます。たとえば、extension_fe2174665583431c953114ff7268b7b3_Education_CourseName 属性には、セクションの講座名が格納されます。

学生のメンバーシップの取得

学生のメンバーシップは、次に示すクエリを使用することで取得できます。

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

応答の種類

応答には、学生がメンバーになっている複数の Group や DirectoryRole、AdministrativeUnit が含まれています。

セクションのフィルター

学生のセクションは、extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Section'objectType == 'Group' に関するフィルター処理によって取得できます。


次の手順

関心がおありかもしれないその他の教育に関連するリソース

アプリケーション開発を開始する準備ができている方にも、単に詳しい情報を必要としている方にも、最適なコンテンツをご用意しています。

Office 365 プラットフォームの使い方の詳細については、次のリンク先をご覧ください。

© 2018 Microsoft