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 とクエリを構築する必要もあります。次に示す各例は、クエリを作成する際に利用できます。

すべての教育機関 REST API の操作

Azure Active Directory では、教育機関が管理単位として表されます。テナントで使用可能な教育機関を取得できます。また、教育機関エンティティに含まれるセクション、学生、および教師も取得できます。

教育機関を取得する | 教育機関内のセクションを取得する | 教育機関内の学生を取得する | 教育機関内の教師を取得する

API のテスト

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

教育機関 REST API の使用

教育機関 REST API と対話する場合は、HTTP GET 要求を送信します。

すべての教育機関 REST API 要求で次のルート URL を使用します。

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

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

注: すべての要求で URL に「beta」を指定する必要があります。

教育機関の属性

教育機関に関する情報を特定する際に役立つ属性の説明については、教育機関の属性


教育機関の取得

すべての教育機関を取得することも、id ごとに 1 つの教育機関を取得することも、クエリのフィルター セットに一致する教育機関のコレクションを取得することもできます。

すべての教育機関の取得

Azure Active Directory テナント内に存在する、すべての教育機関を取得します。

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

応答の種類

教育機関エンティティのコレクション。


1 つの教育機関の取得

を使用して、1 つの教育機関を取得します。id

GET https://graph.microsoft.com/beta/administrativeUnits/{id}
必須パラメーター説明
URL パラメータ
id文字列Azure Active Directory の教育機関管理単位の ID。

応答の種類

要求された教育機関エンティティ。


教育機関内のセクションの取得

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

特定の教育機関のセクションは、教育機関 ID に基づいたグループにクエリを実行することで取得できます。このとき、クエリでは extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType 属性と extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId 属性を同時に使用します。

GET  https://graph.microsoft.com/beta/groups?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Section'%20and%20extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId%20eq%20'10002'
必須パラメーター説明
URL パラメータ
school_id文字列School Information System (SIS) での教育機関の ID。教育機関の取得の出力。

応答の種類

セクション エンティティのコレクション。


教育機関内の学生の取得

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

特定の教育機関の学生は、教育機関管理単位のメンバーになり、アプリケーションで結果のコレクションから学生以外のユーザーをフィルターで除外することで取得できます。

教育機関のメンバーの取得

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
必須パラメーター説明
URL パラメータ
id文字列Azure Active Directory の教育機関管理単位の ID。

応答の種類

ユーザーのコレクション。

学生の検索

ユーザーのコレクションには、学生、教職員、および教育に関わらない (管理スタッフなどの) ユーザーが含まれていることがあります。アプリケーションでは、学生を抽出するフィルターをコレクションに適用しできます。Student と等しくなる Education_ObjectType 拡張属性を検索します。

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'

教育機関内の教師の取得

Azure Active Directory では、教職員はユーザーとして表されます。ユーザーについての拡張属性により、教職員固有の属性が追加されます。たとえば、extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber 属性には教師の教師番号が格納されます。

特定の教育機関の教職員は、教育機関管理単位のメンバーになり、アプリケーションで結果のコレクションから教職員以外のユーザーをフィルターで除外することで取得できます。

教育機関のメンバーの取得

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
必須パラメーター説明
URL パラメータ
id文字列Azure Active Directory の教育機関管理単位の ID。

応答の種類

ユーザーのコレクション。

教職員の検索

ユーザーのコレクションには、学生、教職員、および教育に関わらない (管理スタッフなどの) ユーザーが含まれていることがあります。アプリケーションでは、教職員を抽出するフィルターをコレクションに適用できます。Teacher と等しくなる Education_ObjectType 拡張属性を検索します。

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'

次の手順

次に、興味の対象になると考えられる、その他の Education に関連するリソースを示します。

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

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

© 2018 Microsoft