LRS和Tincan API中的自定义属性_web Api自定义属性中的不同Thread.Principal_属性上的自定义属性 - 获取属性的类型和值 - 腾讯云开发者社区

LRS和Tincan API中的自定义属性

学习记录存储（LRS）和Tin Can API（也称为Experience API或xAPI）允许在陈述（statements）中包含自定义属性，这些属性可以为学习活动提供额外的上下文和信息。以下是在LRS和Tincan API中使用自定义属性的一些方法：

1. 在陈述中添加自定义属性

在Tin Can API中，陈述（statements）是由演员（actor）、动词（verb）、对象（object）和可选的结果（result）、上下文（context）等部分组成的JSON对象。自定义属性通常添加到context或result部分。

示例陈述：

{
  "actor": {
    "name": "John Doe",
    "mbox": "mailto:john.doe@example.com"
  },
  "verb": {
    "id": "http://adlnet.gov/expapi/verbs/completed",
    "display": {"en-US": "completed"}
  },
  "object": {
    "id": "http://example.edu/course/module1",
    "definition": {
      "name": {"en-US": "Module 1"},
      "description": {"en-US": "Introduction to Module 1"}
    }
  },
  "context": {
    "contextActivities": {
      "parent": [{
        "id": "http://example.edu/course",
        "definition": {
          "name": {"en-US": "Course Name"}
        }
      }]
    },
    "custom": {
      "courseSection": "Section A",
      "enrollmentDate": "2023-01-15"
    }
  }
}

在上面的示例中，custom对象包含了两个自定义属性：courseSection和enrollmentDate。

2. 使用扩展（Extensions）

Tin Can API还支持通过extensions属性添加自定义数据。这允许你将数据关联到陈述的特定部分，如动词、对象或结果。

示例使用扩展：

{
  "actor": {
    "name": "John Doe",
    "mbox": "mailto:john.doe@example.com"
  },
  "verb": {
    "id": "http://adlnet.gov/expapi/verbs/completed",
    "display": {"en-US": "completed"},
    "extensions": {
      "http://example.edu/extensions/courseLevel": "Advanced"
    }
  },
  "object": {
    "id": "http://example.edu/course/module1",
    "definition": {
      "name": {"en-US": "Module 1"},
      "description": {"en-US": "Introduction to Module 1"}
    }
  }
}

在这个例子中，extensions属性被添加到了verb对象中，并使用了一个自定义的URI来标识courseLevel属性。