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/groups

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

セクションの属性

セクションに関する情報を特定する際に役立つ属性の説明については、「セクションの属性」をご覧ください。


セクションの取得

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

すべてのセクションの取得

Azure Active Directory テナント内に存在する、すべてのセクションを取得します。

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

応答の種類

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


1 つのセクションの取得

を使用してセクションを取得します。id

GET https://graph.microsoft.com/beta/groups/{id}
必須パラメーター説明
URL パラメータ
id文字列Azure Active Directory のセクション グループの ID。

応答の種類

要求されたセクション エンティティ。


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

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

セクションに関連付けられた教育機関は、「セクションの取得」の extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId 応答から得られる SchoolId プロパティで管理単位にクエリを実行することで取得できます。

GET https://graph.microsoft.com/administrativeUnits?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'School'%20
and%20extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId%20eq%20{school_id}
必須パラメーター説明
URL パラメータ
school_id文字列School Information System (SIS) での教育機関の ID。

応答の種類

教育機関エンティティ。


セクション内の学生の取得

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

特定のセクションの学生は、セクションの統合グループのメンバーになり、アプリケーションで結果のコレクションから学生以外のユーザーをフィルターで除外することで取得できます。

セクションのメンバーの取得

GET https://graph.microsoft.com/beta/groups/{id}/members
必須パラメーター説明
URL パラメータ
id文字列Azure Active Directory のセクション グループの ID。

応答の種類

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

学生の検索

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

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'

セクション内の教師の取得

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

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

セクションのメンバーの取得

GET https://graph.microsoft.com/beta/groups/{id}/members
必須パラメーター説明
URL パラメータ
tenant_id文字列Azure Active Directory のテナント ID、またはドメイン名。
id文字列Azure Active Directory のセクション グループの ID。

応答の種類

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

教職員の検索

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

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Teacher'

次の手順

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

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

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

© 2018 Microsoft