Instructure OneRoster 成绩回传 (GPB) 集成支持标准或修改后的 GPB 端点配置。因为它更严格地遵循 OneRoster 规范。端点配置规范建议采用标准 GPB 配置。
此外，为了提高性能，请在 GPB 配置中包含性能端点。
了解更多关于 OneRoster 的信息成绩册终点合规性。
笔记：Instructure 是 OneRoster 的消费者。有关 OneRoster 消费者和提供者的定义，请参阅[此处]。OneRoster简介。
标准级回传
标准 GPB 集成端点在将 Canvas 中的成绩簿数据同步到您的 SIS 时包含作业 sourcedId。
服务呼叫 | 端点 | HTTP 动词 | 必需的 |
|---|
获取所有类别 | /分类 | 得到 | ✓ |
获取所有行项目 | /lineItems | 得到 | ✓ |
获取类的结果 | /classes/{class_id}/results | 得到 | ✓ |
获取类的行项目 | /classes/{class_id}/lineItems | 得到 | ✓ |
获取 LineItem 类的结果 | /classes/{class_id}/lineItems/{li_id}/results | 得到 | ✓ |
获取学生班级成绩 | /classes/{class_id}/students/{student_id}/results | 得到 | ✓ |
置类别 | /categories/{id} | 放 | 𝗫 |
putLineItem | /lineItems/{id} | 放 | ✓ |
putResult | /results/{id} | 放 | ✓ |
修改后的成绩回传
修改后的 GPB 端点在将成绩簿数据从 Canvas 同步到您的 SIS 时会省略作业 sourcedId。
在对新记录的 PUT 请求的响应中，OneRoster 提供商必须返回 sourcedId。然后，集成会存储此数据，以便在执行 API 调用时使用。
服务呼叫 | 端点 | HTTP 动词 | 必需的 |
|---|
获取所有类别 | /分类 | 得到 | ✓ |
获取所有行项目 | /lineItems | 得到 | ✓ |
获取类的结果 | /classes/{class_id}/results | 得到 | ✓ |
获取类的行项目 | /classes/{class_id}/lineItems | 得到 | ✓ |
获取 LineItem 类的结果 | /classes/{class_id}/lineItems/{li_id}/results | 得到 | ✓ |
获取学生班级成绩 | /classes/{class_id}/students/{student_id}/results | 得到 | ✓ |
置类别 | /categories/{id} | 放 | 𝗫 |
putLineItem | /lineItems/{id} | 放 | ✓ |
putResult | /results/{id} | 放 | ✓ |
putCategory* | /类别* | 放 | 𝗫 |
putLineItem* | /lineItems* | 放 | ✓ |
putResult* | /结果* | 放 | ✓ |
*这些 API 调用中省略了 sourcedId
绩效等级回传终点
至少应实现以下性能等级回传集成端点方法之一。
服务呼叫 | 端点 | HTTP 动词 | 必需的 |
|---|
获取筛选后的类类别 | /categories?filter=metadata.classId='{class_id}' | 得到 | 𝗫* |
获取类的类别 | /classes/{class_id}/categories | 得到 | ✓** |
*虽然并非绝对必要，但实施此筛选条件可以避免拉取和缓存所有类别。
**如果您不实施该类别元数据.类ID此实现是必需的。它允许类与类别关联。