配置 Instructure OneRoster 集成时，请查看成绩回传集成注意事项。Instructure OneRoster 成绩回传 (GPB) 集成包含 OneRoster 规范的多种变体，以满足不同 SIS 提供商的需求。
评分类别
根据您的SIS成绩册配置，您可以自定义获取类别查询以将 Canvas 中的作业正确同步到您的 SIS 成绩簿。
评分周期
由于大多数学生信息系统 (SIS) 提供商会根据作业的截止日期自动计算评分周期，因此您可能不需要将此端点包含在成绩传递配置中。
行项目有效载荷
您可以配置您的订单项请求。了解更多关于 OneRoster 的信息行项目类别数据结构。
结果有效载荷
您可以配置您的订单项请求。了解更多关于 OneRoster 的信息结果。
笔记：Instructure 是 OneRoster 的消费者。有关 OneRoster 消费者和提供者的定义，请参阅[此处]。OneRoster简介。
评分类别
当 Instructure OneRoster 集成运行等级同步时，获取所有类别请求返回所有SIS成绩册评分类别。
任何不包含以下内容的评分类别metadata.classId字段被视为一个全局类别，可以在所有类中应用和使用。
全球类别
如果您的 SIS 成绩册仅支持全局评分类别，则即使没有元数据字段，集成也应该可以正常工作。
类别对象扩展：metadata.classId
为了使 OneRoster API v1.1 能够更正确地关联成绩传递规范中的类别和其他对象，需要一个类别字段。
以下扩展程序允许集成程序正确识别成绩回传所需的 SIS 评分类别。任何不包含此类别的类别都将无法正常工作。metadata.classId字段被假定为全局的，并且与 Canvas 作业组名称匹配的第一个类别名称将用于 GPB。
如果您选择支持metadata.classId此外，您还应该包含一个筛选查询。获取类别端点。这允许集成提取单个部分的类别。
类别对象扩展 |
|---|
{
“categories”: [
{
“status”: “active”,
“title”: “Assessments”,
“sourcedId”: “guid”,
“href”: “SIS 中资源的 URI”,
“metadata”: {
“classId”: “{class_id}”
},
“dateLastModified”: null
}…
]
} |
端点选项：getCategoriesForClass
为了配合 OneRoster API 1.2 规范的发布，您可以添加对新功能的支持。获取类的类别端点。这使得集成能够在成绩回传同步期间识别某个部分的可用 SIS 评分类别。
笔记：如果采用这种方法，则无需配置对以下功能的支持：metadata.classId 场地。
没有匹配的类别
您的 Instructure OneRoster 集成可能已配置为将 Canvas 作业同步到 SIS 评分类别。在成绩同步期间，如果找不到匹配的类别，则会显示错误消息，指出 SIS 评分类别名称与 Canvas 作业组名称不匹配。
默认类别
您的学生信息系统 (SIS) 可能包含默认设置sourcedId所有学生信息系统 (SIS) 成绩册均支持此评分类别。从 Canvas 同步成绩时，如果作业无法与 SIS 评分类别匹配，则会同步到默认评分类别。
如果是一个共同类别sourcedId如果不可用，也可以将此值发送为无效的。
未发送类别
如果贵机构的学生信息系统 (SIS) 支持不带评分类别的成绩簿，则可以将 Instructure OneRoster 集成配置为发送不带或带类别字段的作业 lineItem JSON。“类别”：空集成可以选择始终发送 无效的或者只发送 无效的如果找不到匹配的类别。
或者，您现有的集成可能已将未分类的作业条目自动同步到学生信息系统 (SIS) 成绩簿的未分类评分类别。如果您的集成属于这种情况，教师可以将作业移动到相应的 SIS 评分类别。为防止作业重新同步到未分类字段，您的集成应配置为将手动分配的类别识别为固定字段。
覆盖类别
贵机构的SIS成绩册可能配置了一个始终使用的预选默认评分类别。为了适应此配置，您的Instructure OneRoster集成可以包含一个硬编码的类别。sourcedId贵校学生信息系统 (SIS) 中的所有教师成绩册都必须包含此类别。或者，也可以配置集成以覆盖默认设置。无效的类别值。
评分周期
在从 Canvas 同步成绩期间，大多数学生信息系统 (SIS) 会自动计算并关联作业的正确评分周期。到期日行项目。这种自动计算意味着评分周期可以省略或发送该行项目无效的。
如果您的集成需要，评分周期可以配置行项目。但是，如果配置不正确，成绩同步错误将更频繁地发生。
了解更多OneRoster学术课程。
项目有效载荷考虑因素
您可以配置要包含在 GPB 同步有效负载中的行项目请求。
下图显示了可配置的订单项请求。在客户端配置过程中，您可以自定义大多数默认值。您也可以从有效负载中省略任何这些值。此外，如果 Canvas 数据提取中包含相关数据，您还可以配置其他元数据字段。
了解更多关于 OneRoster 的信息行项目类别数据结构。
*看 类别成绩反馈实施说明
**请参阅成绩回传实现说明，了解评分周期。
有效载荷配置示例
带有 SourceID 的有效载荷示例 |
|---|
{
“lineItem”: {
“sourcedId”: "799e2caf-728d-4ef6-8ff9-5325e64cecd5"
“status”: "active",
“title”: "Canvas 测试作业 1",
“description”: "从 Canvas 导入："https://school.instructure.com/courses/5582/assignments/135”,
"resultValueMax": 10,
"resultValueMin": 0,
"assignDate": "2021-03-10T23:59:59",
"dueDate": "2021-03-10T23:59:59",
"metadata": {
"vendorId": ""
},
"class": {
"href": "~/ims/oneroster/v1p1/classes/100453379",
"sourcedId": "100453379",
"type": "class"
},
"category": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
"sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
"type": "category"
},
"gradingPeriod": null
} |
不含 SourceID 的有效载荷示例 |
|---|
{
“lineItem”：{
“status”：“active”，
“title”：“Canvas 测试作业 1”，
“description”：“从 Canvas 导入：https://school.instructure.com/courses/5582/assignments/135”,
"resultValueMax": 10,
"resultValueMin": 0,
"assignDate": "2021-03-10T23:59:59",
"dueDate": "2021-03-10T23:59:59",
"metadata": {
"vendorId": ""
},
"class": {
"href": "~/ims/oneroster/v1p1/classes/100453379",
"sourcedId": "100453379",
"type": "class"
},
"category": {
"href": "~/ims/oneroster/v1p1/categories/C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
sourcedId": "C5C3AC8C-8D0F-48EB-96F4-31437B640D16",
type": "category"
},
gradingPeriod": null
}
} |
结果有效载荷考虑因素
您可以配置包含在 GPB 同步中的结果有效负载。
下图显示了可配置的订单项请求。在客户端配置过程中，您可以自定义大多数默认值。您也可以从有效负载中省略任何这些值。此外，如果 Canvas 数据提取中包含相关数据，您还可以配置其他元数据字段。
了解更多关于 OneRoster 的信息结果。
OneRoster 字段名称 | 默认值 |
|---|
sourcedId | {sourcedId} |
行项目 | {OneRoster lineItem 引用对象} |
学生 | {OneRoster 用户引用对象} |
得分状态 | “已完全评分”、“未提交”或“豁免” |
分数 | 提交分数 |
评论 | 默认省略* |
得分日期 | 默认省略** |
*有关评论，请参阅成绩传递实现说明。
**请参阅成绩回传实现说明，了解 scoreDate 的具体信息。
有效载荷示例 |
|---|
{
“result”：{
“sourcedId”：“0031e9ee-5bd0-4d80-a5f7-5c14fe75acc0”，
“lineItem”：{
“href”：“~/ims/oneroster/v1p1/lineItems/0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”，
“sourcedId”：“0ea49ae5-4a6b-45d5-a0c2-b01facbfbc5f”，
“type”：“lineItem”
}，
“student”：{
“href”：“~/ims/oneroster/v1p1/students/S100051158”，
"sourcedId": "S100051158",
"type": "student"
},
"scoreStatus": "fully graded",
"score": 10
}
} |
得分
在 Canvas 中，教师可以设置负分，也可以设置超过最高分的分数。请考虑您的集成方案将如何处理这些潜在情况。
在某些情况下，例如豁免情况。得分状态您的集成应配置为传递一个无效的得分值，否则为0分数将传递给学生信息系统（SIS）。
画布上的 scoreStatus 值 | 笔记 |
|---|
完全分级 |
提交.工作流状态 = 已评分应该始终关联一个评分。
|
未提交 |
提交缺失 = true大多数情况下，只有当有分数关联时才会通过，但也有可能没有分数。得分=null
|
豁免 |
submission.excused = true得分将是无效的默认情况下或0
|