xAPI HTTP Interfaces

RESTful HTTP API (API 通用規則)

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

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

  • 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 ""