学校データ同期によってアクセスされる OneRoster API データ

  • [アーティクル]

重要

School Data Sync で教育機関のデータを接続して利用できるようにすることで、このデータを Microsoft と共有し、organizationのデータ ガバナンス標準に準拠することをコミットする権限があることを確認します。

OneRoster API (アプリケーション プログラミング インターフェイス) は、学生情報システム (SIS) /学生管理システム (SMS) データの交換のために、1EdTech (旧称 IMS Global) からの業界標準の形式です。 この同期方法を使用すると、SIS/SMS プロバイダーによって開発された REST ベースの OneRoster 1.1 API を使用して、SIS/SMS に直接接続できます。 API サポートを使用すると、CSV (コンマ区切り値) ファイルを使用する代わりに、データを直接同期できます。

次の一覧は、OneRoster API を使用して SIS/SMS に接続するときにアクセスされるデータを理解するのに役立ちます。

学校データに必要な OneRoster API エンドポイント

アクション URL 必須のフィルター プロパティ 省略可能/推奨フィルター 例
GetAllAcademicSessions /academicSessions status dateLastModified /academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}'
GetAllOrgs /Orgs status dateLastModified /orgs?offset=0&limit=5000&filter=status='active'/orgs?filter=dateLastModified>'{deltaDateTime}'
GetAllUsers /ユーザー status dateLastModified /users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}'
GetAllClasses /クラス status dateLastModified /classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}'
GetAllEnrollments /入学 status dateLastModified /enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'

学校データ同期用の省略可能な API エンドポイント

注:

人口統計、学生の連絡先関係、学生ユーザー フラグのオプションのデータの場合、このデータを含めるかどうかは、SIS/SMS OneRoster プロバイダー プロファイルでサポートされているオプションのデータ機能に基づいて行われます。 SIS/SMS プロバイダーもこのデータをサポートしている場合は、トグル (既定値) が [オン] に選択され、追加のデータが含まれます。 必要に応じて、トグルを選択してオフにすることができます。 トグルが使用できない場合、表示はオフで、操作に使用できない場合は、プロバイダーのプロファイルがそのデータの提供を現在サポートしていないことを意味します。

注:

プロバイダーのプロファイルに人口統計、連絡先、またはユーザーの人口統計フラグが利用不可と表示され、その機能をサポートしたい場合は、 プロバイダーに問い合わせてサポートの追加を要求 して、SDS がデータを取り込み、データサポートのシナリオとエクスペリエンスを有効にできるようにします。 

アクション URL 必須のフィルター プロパティ 省略可能/推奨フィルター 例
GetAllCourses /コース status dateLastModified /courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics /人口 統計 status dateLastModified /demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'