学校数据同步访问的 OneRoster API 数据
重要
通过学校数据同步连接和提供机构数据，你确认你有权与 Microsoft 共享此数据，并承诺遵守组织的数据治理标准。
OneRoster API (应用程序编程接口) 是一种行业标准格式，从 1EdTech (以前是 IMS Global) ，用于交换学生信息系统 (SIS) /学生管理系统 (短信) 数据。 使用此同步方法，可以使用 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}' |