xAPI HTTP Interfaces

RESTful HTTP API (API 通用规则)

  下列各 API 均需要加入 Header、HTTP Basic Authentication 讯息方可使用。

Endpoint:http://www.visualcatch.org/visca/TCAPI/

Header

  • X-Experience-API-Version:1.0.1
  • Content-Type:application/json

HTTP Basic Authentication

  • Username
  • Password

学习纪录 API (Records API)

Statement API

PUT a Statement

  新增一笔语句 (Statement)。

Endpoint:http://www.visualcatch.org/visca/TCAPI/statements

参数 属性 简述 必要性
statementId String 该语句 (Statement) 的 Id 必要
Request body 欲新增之语句 (Statement) 必要

POST Statements

  新增多笔语句 (Statement)。

Endpoint:http://www.visualcatch.org/visca/TCAPI/statements

参数 属性 简述 必要性
Request body 欲新增之语句 (Statement),至少 1 笔 必要

GET Statements

  取得语句 (Statement)

Endpoint:http://www.visualcatch.org/visca/TCAPI/statements

参数 属性 预设 简述 必要性
statementId String 欲查询之 statement Id
voidedStatementId String 欲查询之 voided statement Id
agent Agent or Identified Group Object (JSON) 欲查询之 agent
verb Verb id (IRI) 欲查询之 verb Id
activity Activity id (IRI) 欲查询之 activity Id
registration UUID 欲查询之 registration Id
related_activities Boolean False 若值为 True 则会将 Activity 进行深度搜寻,其范围包括 Object、每一个 Context Activity、每一个含有 Activity 的 Sub-Statement
related_agents Boolean False 若值为 True 则会将 Agent 进行深度搜寻,其范围包括 Actor、Object、Authority、Instructor、Team 及每一个含有 Agent 的 Sub-Statement
since Timestamp 指定 timestamp 之起始时间
until Timestamp 指定 timestamp 之结束时间
limit Nonnegative Integer 0 指定回传的最高数量。输入 0 则表示回传最大值
format String: ("ids", "exact", or "canonical") exact 若为 "ids" 在 Agent、Activity、Group Objects 中将仅会回传最小之必要信息 (识别 ID)
attachments Boolean False 若值为 True 则会回传 multipart 格式,并且包括 attachments。若为 False,将会回传 application/json 格式,但不含其 attachments
ascending Boolean False 若值为 True 将会依照 timestamp 进行升幂排序

Document API

  Document APIs 主要用来存取语句 (Statement) 以外的信息(如:文件、班级信息... 等),本身不会影响到语句 (Statement)。 Document APIs 包括 State API、Activity Profile API、Agent Profile API。 State API 通常用于暂存活动内容的状态,以便在不同的会话、设备中重现学习活动;Activity Profile API 用于存放和获取活动的完整描述;Agent Profile API 用于存放和获取学习者的资料。这三个 API 也都遵循 RESTful 架构,并支援对 LRS 中的资料进行操作处理。

State API

  用以来储存额外的活动状态信息,或作为跨设备状态储存之用。

Single Document GET | DELETE

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities/state

参数 属性 简述 必要性
activityId String 与此状态相关的 Activity Id 必要
agent JSON 与此状态相关的 Agent 必要
stateId String 依照情境给定此状态之 Id 必要
registration UUID 与此状态相关联的 Registration Id

Single Document PUT | POST

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities/state

参数 属性 简述 必要性
activityId String 与此状态相关的 Activity Id 必要
agent JSON 与此状态相关的 Agent 必要
stateId String 依照情境给定此状态之 Id 必要
registration UUID 与此状态相关联的 Registration Id
Request body 欲储存之状态档案 必要

Multiple Document GET

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities/state

参数 属性 简述 必要性
activityId String 与此状态相关的 Activity Id 必要
agent JSON 与此状态相关的 Agent 必要
since Timestamp 搜寻的起始时间
registration UUID 与此状态相关联的 Registration Id

Multiple Document DELETE

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities/state

参数 属性 简述 必要性
activityId String 与此状态相关的 Activity Id 必要
agent JSON 与此状态相关的 Agent 必要
registration UUID 与此状态相关联的 Registration Id

Agent Profile API

  与 State API 功能类似。 Agent Profile API 允许针对 Agent 去储存各种键值与文件。

Combined Information GET

Endpoint:http://www.visualcatch.org/visca/TCAPI/agents

参数 属性 简述 必要性
agent Object (JSON) 与此状态相关的 Agent 必要

Single Agent or Profile GET | DELETE

Endpoint:http://www.visualcatch.org/visca/TCAPI/agents/profile

参数 属性 简述 必要性
agent Object (JSON) 与此状态相关的 Agent 必要
profileId String 与此档案相关的 Profile Id 必要

Single Agent or Profile PUT | POST

Endpoint:http://www.visualcatch.org/visca/TCAPI/agents/profile

参数 属性 简述 必要性
agent Object (JSON) 与此状态相关的 Agent 必要
profileId String 与此档案相关的 Profile Id 必要
Request body 欲储存之学习者档案

Multiple Agent or Profile GET

Endpoint:http://www.visualcatch.org/visca/TCAPI/agents/profile

参数 属性 简述 必要性
agent Object (JSON) 必要
since Timestamp 搜寻的起始时间

Activity Profile API

  与 State API 功能类似。 Activity Profile API 允许针对 Activity 去储存各种键值与文件。

Full Activity Object GET

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities

参数 属性 简述 必要性
activityId String 与此活动档案相关的 Activity Id 必要

Single Document GET | DELETE

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities/profile

参数 属性 简述 必要性
activityId String 与此活动档案相关的 Activity Id 必要
profileId String 与此活动档案相关的 Profile Id 必要

Single Document PUT | POST

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities/profile

参数 属性 简述 必要性
activityId String 与此活动档案相关的 Activity Id 必要
profileId String 与此活动档案相关的 Profile Id 必要
Request body 欲储存之活动档案 必要

Multiple Document GET

Endpoint:http://www.visualcatch.org/visca/TCAPI/activities/profile

参数 属性 简述 必要性
activityId String 与此活动档案相关的 Activity Id 必要
since Timestamp 搜寻的起始时间

results matching ""

    No results matching ""