载入 OneRoster API 使用者进行等级同步

注意

有关与 SDS 集成和发送名册数据的详细信息和步骤,请参阅 OneRoster API 提供程序与学校数据同步的载入指南

简介

Microsoft 等级同步可以将分配和等级信息同步到任何实现 IMS OneRoster® API 标准的系统。 本文档旨在帮助 OneRoster API 的任何新提供程序成功与等级同步集成。以下载入过程定义 API 提供程序所需的步骤,然后才能添加这些步骤,以便租户选择和使用学校数据同步 (SDS) 。

使用 OneRoster 等标准是使诸如“等级同步”等功能能够根据客户的所有需求进行缩放的唯一方法。

概述

  1. SDS 合作伙伴注册表单上完成表单

  2. 实现等级同步所需的 OneRoster API 终结点。

  3. 验证等级同步是否适用于 OneRoster API 终结点。 针对沙盒环境测试等级同步工程。

  4. 与两个生产客户一起试用该解决方案。

  5. 使连接器在 SDS 中正式发布,适用于所有Office 365 EDU 租户。

  6. 承诺与 Microsoft 共同拥有。

为何需要与 SDS 集成以获取名册数据

虽然“等级同步”确实是为了将 Microsoft 和 Teams 的作业和成绩从你的 SIS 中获取,但 SDS 是将你的名册信息引入 Microsoft 的原因。 需要通过 SDS 将数据引入,因为它允许级别同步在 Microsoft 365 租户和 SIS 之间无缝工作。 等级同步依赖于 SIS 与客户租户之间由 SDS 保存的标识及其同步记录。

开始使用

实现 OneRoster v1.1 终结点以使用分配和等级数据

虽然 SIS 数据初始集成到 SDS 需要多个 OneRoster v1.1 终结点,但同步等级数据需要额外的访问权限。 下面的终结点是必需的。 有关终结点的完整详细信息,请访问 OneRoster API v1.1 的分配和等级传递后 页。

操作 URL 方法
一个班级的学生 /classes/{class_id}/students GET
课堂教师 /classes/{class_id}/teachers GET
所有教师 /教师 GET
教师课程 /teachers/{teacher_id}/classes GET
所有用户 /用户 GET
类的所有行项 /classes/{class_id}/lineitems GET
单行项的结果 /classes/{class_id}/lineitems/{lineitem_id}/results GET
特定班级中单个学生的结果 /classes/{class_id}/students/{student_id}/results GET
更新特定行项 /lineItems/{lineitem_id} PUT
更新特定结果 /results/{result_id} PUT

有用的提示

  • {lineitem_id} 和 {result_id} 对应于要返回的每个行项或结果的 sourcedId 属性。

  • 某些终结点对筛选器参数支持有要求,允许通过电子邮件和 sourcedId 进行筛选。

  • 提供商必须实施 OAuth1 () 授权方案,这是 GradeSync 目前支持的唯一方案。

  • 在开发过程中,可以考虑使用 OneRoster 级同步 Postman 集合验证终结点。

测试 OneRoster 分配和等级 API

我们已使用等级同步要求更新了 OneRoster API Postman 集合。 更新后的集合调用除 SDS 之外的 GradeSync 的所有 API。 它创建一个新的分配,并在每次执行时向其添加一个等级。 下载并运行 OneRoster 级同步 Postman 集合

集合在创建的作业和成绩上调用 DELETE 以进行清理。 但是,实现 DELETE API 是可选的,因为它们当前不由等级同步使用。

承诺与 Microsoft 共同拥有

  • 与 Microsoft 联系人创建协议,以对此协作的以下方面负责:

    • 测试环境包括为 Microsoft 提供类似生产环境的测试环境,该环境将在启动日期之后保持正常运行。

    • 共同开发包括帮助解决启动前后的开发和测试问题。

    • 共同服务包括帮助解决关键的客户问题,包括为严重性 1 问题提供升级路径,这些问题具有处理实时站点问题的响应方。

    • 共同营销和共同推广包括与社区进行适当的沟通,以帮助我们激发对启动的兴奋。

相关文章

使用学校数据同步载入 OneRoster API 提供程序的指南

使用 OneRoster API 进行数据引入