Learning Plan

A learning plan is a collection of multiple activities. Activity providers are required to put the definitions of each activity into VisCa so that the learning plan data viz could be shown correctly. Document API of xAPI is used by VisCa to stored all kinds of metadata of the Learning Plan.

Put Plan Metadata

Method: PUT

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

Parameter Type Static Value Description Required
`activityId URL the unique URL referenced by the Learning Plan Required
profileId URL https://w3id.org/xapi/acrossx/profile/learning-plan the profile ID of the Learning Plan defined by Chinese xAPI CoP Required
body JSON refer to the table of "Activity Object" a collection of activity objects Required

Return: 204 No Content

Activity Object

Parameter Type Static Value Description Required
instructor Account Object the person who created or designed the plan Required
name String name of the plan Required
description String description of the plan Optional
create_date ISO 8601 String the date when the plan was created Required
alignment Array of URLs or Strings various standards that the plan aligned with (ex:Common Core Standard) Recommended
users Array of Agent Objects users assigned to consume the plan Required
activities Array of Activity Definition Objects Refer to the table of "Activity Definition Object" a collection of activities inside the plan Required

Activity Definition Object

Parameter Type Static Value Description Required
id URL unique URL refer to the activity Required
name String name of the activity Required
description String description of the activity Optional
type URL https://w3id.org/xapi/acrossx/activities/video or https://w3id.org/xapi/acrossx/activities/e-book or http://adlnet.gov/expapi/activities/assessment or https://w3id.org/xapi/acrossx/activities/practice or https://w3id.org/xapi/acrossx/activities/document unique URL refer to specific type of the activity defined by xAPI Chinese CoP (should refer to each recipe for the complete definition) Required
alignment Array of URLs or Strings various standards that the plan aligned with (ex:Common Core Standard) Recommended
must Boolean false to indicate if the activity is marked as "must have completed" requirement Recommended
requiredTimeSpent ISO 8601 Duration String expected time spent on completing the activity Recommended

Example

{
  "instructor":{
    "objectType":"Agent",
    "name":"teacher",
    "account":{
      "homePage":"https://auth.ischool.com.tw/",
      "name":"9675f710-7fcf-11e6-bdf4-0800200c9a66"
    }
  },
  "name":"Chinese Food",
  "description":"Chinese Food introduction",
  "create_date":"2015-09-21T05:45:34Z",
  "alignment":["http://fake.com/society/1"],
  "users":[
    {
      "objectType":"Agent",
      "name":"student",
      "account":{
        "homePage":"https://auth.ischool.com.tw/",
        "name":"f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
      }
    }
  ],
  "activities":[
    {
      "id":"https://www.youtube.com/watch?v=WtymPK4Kq9M",
      "name":"7 Chinese Foods You MUST Try In Southern China",
      "description":"Chinese food in Southern China and...",
      "type":"https://w3id.org/xapi/acrossx/activities/video",
      "alignment":["http://fake.com/chinese/2"],
      "must":true,
      "requiredTimeSpent":"PT1M30S"
    }
  ]
}

GET Plan Metadata

Method: GET

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

Parameter Type Static Value Description Required
instructor Agent Object the person who created or designed the plan Required
activityId URL the unique URL refer to the Plan Required
profileId URL https://w3id.org/xapi/acrossx/profile/learning-plan the profile ID of the Learning Plan defined by Chinese xAPI CoP Required

Return: 200 OK and the plan metadata

Learning Plan xAPI Statements (coming soon)

  • Instructor assigned a Learning Plan to Actor

  • Actor attempted a Learning Plan

  • Actor attempted an Activity in the Learning Plan

  • Actor designed a Learning Plan

  • Actor viewed a Learning Plan

  • Actor K submitted submission S for Plan / Activity item / Assignment P

  • Instructor O assigned Assignment A to Actor K

  • Actor K completed Activity X successfully

  • Actor K completed Plan P successfully

Instructor assigned a Learning Plan to Actor

Field Type Static Value Description Required
actor Agent Object the person who was assigned the Learning Plan Required
verb.id URL https://w3id.org/xapi/acrossx/verbs/was-assigned the predefined verb Required
object.objectType String Activity Learning Plan is a kind of Activity Required
object.id URL unique url referenced by the Learning Plan Required
object.definition.name.en-US String name of the Learning Plan Required
object.definition.description.en-US String description of the Learning Plan Optional
object.definition.type URL https://w3id.org/xapi/acrossx/activities/plan predefined activity type for Learning Plan Required
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/alignment Array of URLs or Strings specific standards the Learning Plan aligned with Recommended
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/supplemental-info String supplemental information for the Learning Plan Optional
context.instructor Agent Object the person who assigned the Learning Plan Required
context.contextActivities.parent.n.id URL the parent activity of the Learning Plan Optional
context.contextActivities.grouping.n Activity Object course id; any tag(or array of tags) relevant for reporting Optional
context.contextActivities.category.n.id URL https://w3id.org/xapi/acrossx/profile/learning-plan the profile ID of the Learning Plan Required
context.revision String version of the Learning Plan Optional
context.platform URL URL of the platform used Required
context.language String language used in Learning Plan Optional
context.statement Statement Reference refer to the statement of learning plan designed if existed Recommended
context.extensions.http://id.tincanapi.com/extension/browser-info String browser information Recommended
timestamp ISO 8601 String the time when plan was assigned Required
authority Agent Object the person who assigned the Learning Plan Required
{
    "actor":{
        "objectType": "Agent",
        "name": "student",
        "account": {
            "homePage": "https://auth.ischool.com.tw/",
            "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
        }
    },
    "verb":{
        "id":"https://w3id.org/xapi/acrossx/verbs/was-assigned",
        "display":{
            "en-US":"was-assigned"
        }
    },
    "object":{
        "objectType":"Activity",
        "id":"http://visca.org/learning_plan/1",
        "definition":{
            "name":{
                "en-US":"Big Data Analytics"
            },
            "description":{
                "en-US":"Learn everything about Big Data"
            },
            "type":"https://w3id.org/xapi/acrossx/activities/plan",
            "extensions":{
                "https://w3id.org/xapi/acrossx/extensions/alignment":["http://visca.org/alignment/1"]                
            }
        }
    },
    "context":{
        "instructor":{
            "objectType":"Agent",
            "name":"teacher",
            "account": {
              "homePage": "https://auth.ischool.com.tw/",
              "name": "9675f710-7fcf-11e6-bdf4-0800200c9a66"
            }
        },
        "platform":"http://visca.com/planning",
        "language":"en-US",
        "contextActivities":{
            "category":[
                {
                    "objectType":"Activity",
                    "id":"https://w3id.org/xapi/acrossx/profile/learning-plan"
                }
            ]
        },
        "extensions":{
            "http://id.tincanapi.com/extension/browser-info":{ "code_name": "Mozilla", "name": "Netscape", "version": "5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "platform": "MacIntel", "user-agent-header": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "cookies-enabled": true }
        }
    },
    "authority":{
      "objectType":"Agent",
      "name":"teacher",
      "account": {
          "homePage": "https://auth.ischool.com.tw/",
          "name": "9675f710-7fcf-11e6-bdf4-0800200c9a66"
      }
    },
    "timestamp":"2015-09-21T05:45:34Z"
}

Actor attempted a Learning Plan

Field Type Static Value Description Required
actor Agent Object the person who attempted the Learning Plan Required
verb.id URL https://w3id.org/xapi/acrossx/verbs/attempted the predefined verb Required
object.objectType String Activity Learning Plan is a kind of Activity Required
object.id URL unique url referenced by the Learning Plan Required
object.definition.name.en-US String name of the Learning Plan Required
object.definition.description.en-US String description of the Learning Plan Optional
object.definition.type URL https://w3id.org/xapi/acrossx/activities/plan predefined activity type for the Learning Plan Required
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/alignment Array of URLs or Strings specific standards the Learning Plan aligned with Recommended
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/supplemental-info String supplemental information for the Learning Plan Optional
context.instructor Agent Object the person who assigned the Learning Plan Required
context.contextActivities.parent.n.id URL the parent Activity of the Learning Plan Optional
context.contextActivities.grouping.n Activity Object course id; any tag(or array of tags) relevant for reporting Optional
context.contextActivities.category.n.id URL https://w3id.org/xapi/acrossx/profile/learning-plan the profile ID of the Learning Plan Required
context.revision String version of the Learning Plan Optional
context.platform URL URL of the platform used Required
context.language String language used in Learning Plan Optional
context.statement Statement Reference refer to the statement of learning plan designed if existed Recommended
context.extensions.http://id.tincanapi.com/extension/browser-info String browser information Recommended
timestamp ISO 8601 String the time when actor attempted the Learning Plan Required
authority Agent Object the person who attempted the Learning Plan Required
{
    "actor":{
        "objectType": "Agent",
        "name": "student",
        "account": {
            "homePage": "https://auth.ischool.com.tw/",
            "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
        }
    },
    "verb":{
        "id":"https://w3id.org/xapi/acrossx/verbs/attempted",
        "display":{
            "en-US":"attempted"
        }
    },
    "object":{
        "objectType":"Activity",
        "id":"http://visca.org/learning_plan/1",
        "definition":{
            "name":{
                "en-US":"Big Data Analytics"
            },
            "description":{
                "en-US":"Learn everything about Big Data"
            },
            "type":"https://w3id.org/xapi/acrossx/activities/plan",
            "extensions":{
                "https://w3id.org/xapi/acrossx/extensions/alignment":["http://visca.org/alignment/1"]                
            }
        }
    },
    "context":{
        "instructor":{
            "objectType":"Agent",
            "name":"teacher",
            "account": {
              "homePage": "https://auth.ischool.com.tw/",
              "name": "9675f710-7fcf-11e6-bdf4-0800200c9a66"
            }
        },
        "platform":"http://visca.com/planning",
        "language":"en-US",
        "contextActivities":{
            "category":[
                {
                    "objectType":"Activity",
                    "id":"https://w3id.org/xapi/acrossx/profile/learning-plan"
                }
            ]
        },
        "extensions":{
            "http://id.tincanapi.com/extension/browser-info":{ "code_name": "Mozilla", "name": "Netscape", "version": "5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "platform": "MacIntel", "user-agent-header": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "cookies-enabled": true }
        }
    },
    "authority":{
      "objectType":"Agent",
      "name":"student",
      "account": {
          "homePage": "https://auth.ischool.com.tw/",
          "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
      }
    },
    "timestamp":"2015-09-21T05:45:34Z"
}

Actor attempted an Activity in the Learning Plan

Field Type Static Value Description Required
actor Agent Object the person who attempted the Activity Required
verb.id URL https://w3id.org/xapi/acrossx/verbs/attempted the predefined verb Required
object.objectType String Activity Activity included in the Learning Plan is a kind of Activity Required
object.id URL unique url referenced by the Activity Required
object.definition.name.en-US String name of the Activity Required
object.definition.description.en-US String description of the Activity Optional
object.definition.type URL https://w3id.org/xapi/acrossx/activities/video or https://w3id.org/xapi/acrossx/activities/e-book or http://adlnet.gov/expapi/activities/assessment or https://w3id.org/xapi/acrossx/activities/practice or https://w3id.org/xapi/acrossx/activities/document predefined activity type for the Activity Required
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/alignment Array of URLs or Strings specific standards the Activity aligned with Recommended
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/supplemental-info String supplemental information for the Activity Optional
context.instructor Agent Object the person who assigned the Activity Required
context.contextActivities.parent.n.id URL the referenced Url of Learning Plan which the Activity belongs to Optional
context.contextActivities.grouping.n Activity Object course id; any tag(or array of tags) relevant for reporting Optional
context.contextActivities.category.n.id URL https://w3id.org/xapi/acrossx/profile/learning-plan the profile ID of the Learning Plan Required
context.revision String version of the Activity Optional
context.platform URL URL of the platform used Required
context.language String language used in Activity Optional
context.extensions.http://id.tincanapi.com/extension/browser-info String browser information Recommended
timestamp ISO 8601 String the time when actor attempted the Activity Required
authority Agent Object the person who attempted the Activity Required
{
    "actor":{
        "objectType": "Agent",
        "name": "student",
        "account": {
            "homePage": "https://auth.ischool.com.tw/",
            "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
        }
    },
    "verb":{
        "id":"https://w3id.org/xapi/acrossx/verbs/attempted",
        "display":{
            "en-US":"attempted"
        }
    },
    "object":{
        "objectType":"Activity",
        "id":"https://www.youtube.com/watch?v=7D1CQ_LOizA",
        "definition":{
            "name":{
                "en-US":"Explaining Big Data"
            },
            "description":{
                "en-US":"Big Data is the next big thing in computing. This video explains Big Data characteristics, technologies and opportunities."
            },
            "type":"https://w3id.org/xapi/acrossx/activities/video",
            "extensions":{
                "https://w3id.org/xapi/acrossx/extensions/alignment":["http://visca.org/alignment/1"],
                "http://id.tincanapi.com/extension/duration":"PT8M32S"                
            }
        }
    },
    "context":{
        "instructor":{
            "objectType":"Agent",
            "name":"teacher",
            "account": {
              "homePage": "https://auth.ischool.com.tw/",
              "name": "9675f710-7fcf-11e6-bdf4-0800200c9a66"
            }
        },
        "platform":"http://visca.com/planning",
        "language":"en-US",
        "contextActivities":{
            "parent":[
                {
                    "objectType":"Activity",
                    "id":"http://visca.org/learning_plan/1",
                    "definition":{
                        "name":{
                            "en-US":"Big Data Analytics"
                        },
                        "description":{
                            "en-US":"Learn everything about Big Data"
                        },
                        "type":"https://w3id.org/xapi/acrossx/activities/plan",
                        "extensions":{
                            "https://w3id.org/xapi/acrossx/extensions/alignment":["http://visca.org/alignment/1"]                
                        }
                    }
                }
            ],
            "category":[
                {
                    "objectType":"Activity",
                    "id":"https://w3id.org/xapi/acrossx/profile/learning-plan"
                }
            ]
        },
        "extensions":{
            "http://id.tincanapi.com/extension/browser-info":{ "code_name": "Mozilla", "name": "Netscape", "version": "5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "platform": "MacIntel", "user-agent-header": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "cookies-enabled": true }
        }
    },
    "authority":{
      "objectType":"Agent",
      "name":"student",
      "account": {
          "homePage": "https://auth.ischool.com.tw/",
          "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
      }
    },
    "timestamp":"2015-09-21T05:45:34Z"
}

Actor designed a Learning Plan

Field Type Static Value Description Required
actor Agent Object the person who designed the Learning Plan Required
verb.id URL https://w3id.org/xapi/acrossx/verbs/designed the predefined verb Required
object.objectType String Activity Learning Plan is a kind of Activity Required
object.id URL unique url referenced by the Learning Plan Required
object.definition.name.en-US String name of the Learning Plan Required
object.definition.description.en-US String description of the Learning Plan Optional
object.definition.type URL https://w3id.org/xapi/acrossx/activities/plan predefined activity type for Learning Plan Required
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/alignment Array of URLs or Strings specific standards the Learning Plan aligned with Recommended
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/supplemental-info String supplemental information for the Learning Plan Optional
context.instructor Agent Object the person who designed the Learning Plan Required
context.contextActivities.parent.n.id URL the parent Activity of the Learning Plan Optional
context.contextActivities.grouping.n Activity Object course id; any tag(or array of tags) relevant for reporting Optional
context.contextActivities.category.n.id URL https://w3id.org/xapi/acrossx/profile/learning-plan the profile ID of the Learning Plan defined by Chinese xAPI CoP Required
context.revision String version of the Learning Plan Optional
context.platform URL URL of the platform used Required
context.language String language used in Learning Plan Optional
context.statement Statement Reference refer to the statement of learning plan designed if existed Recommended
context.extensions.http://id.tincanapi.com/extension/browser-info String browser information Recommended
timestamp ISO 8601 String the time when actor designed the Learning Plan Required
authority Agent Object the person who designed the Learning Plan Required
{
    "actor":{
        "objectType": "Agent",
        "name": "teacher",
        "account": {
            "homePage": "https://auth.ischool.com.tw/",
            "name": "9675f710-7fcf-11e6-bdf4-0800200c9a66"
        }
    },
    "verb":{
        "id":"https://w3id.org/xapi/acrossx/verbs/designed",
        "display":{
            "en-US":"designed"
        }
    },
    "object":{
        "objectType":"Activity",
        "id":"http://visca.org/learning_plan/1",
        "definition":{
            "name":{
                "en-US":"Big Data Analytics"
            },
            "description":{
                "en-US":"Learn everything about Big Data"
            },
            "type":"https://w3id.org/xapi/acrossx/activities/plan",
            "extensions":{
                "https://w3id.org/xapi/acrossx/extensions/alignment":["http://visca.org/alignment/1"]                
            }
        }
    },
    "context":{
        "instructor":{
            "objectType":"Agent",
            "name":"teacher",
            "account": {
              "homePage": "https://auth.ischool.com.tw/",
              "name": "9675f710-7fcf-11e6-bdf4-0800200c9a66"
            }
        },
        "platform":"http://visca.com/planning",
        "language":"en-US",
        "contextActivities":{
            "category":[
                {
                    "objectType":"Activity",
                    "id":"https://w3id.org/xapi/acrossx/profile/learning-plan"
                }
            ]
        },
        "extensions":{
            "http://id.tincanapi.com/extension/browser-info":{ "code_name": "Mozilla", "name": "Netscape", "version": "5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "platform": "MacIntel", "user-agent-header": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "cookies-enabled": true }
        }
    },
    "authority":{
      "objectType":"Agent",
      "name":"student",
      "account": {
          "homePage": "https://auth.ischool.com.tw/",
          "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
      }
    },
    "timestamp":"2015-09-21T05:45:34Z"
}

Actor viewed a Learning Plan

Field Type Static Value Description Required
actor Agent Object the person who viewed the Learning Plan Required
verb.id URL http://id.tincanapi.com/verb/viewed the predefined verb Required
object.objectType String Activity Learning Plan is a kind of Activity Required
object.id URL unique url referenced by the Learning Plan Required
object.definition.name.en-US String name of the Learning Plan Required
object.definition.description.en-US String description of the Learning Plan Optional
object.definition.type URL https://w3id.org/xapi/acrossx/activities/plan predefined activity type for Learning Plan Required
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/alignment Array of URLs or Strings specific standards the Learning Plan aligned with Recommended
object.definition.extensions.https://w3id.org/xapi/acrossx/extensions/supplemental-info String supplemental information for the Learning Plan Optional
context.instructor Agent Object the person who designed the Learning Plan Required
context.contextActivities.parent.n.id URL the parent Activity of the Learning Plan Optional
context.contextActivities.grouping.n Activity Object course id; any tag(or array of tags) relevant for reporting Optional
context.contextActivities.category.n.id URL https://w3id.org/xapi/acrossx/profile/learning-plan the profile ID of the Learning Plan defined by Chinese xAPI CoP Required
context.revision String version of the Learning Plan Optional
context.platform URL URL of the platform used Required
context.language String language used in Learning Plan Optional
context.statement Statement Reference refer to the statement of learning plan designed if existed Recommended
context.extensions.http://id.tincanapi.com/extension/browser-info String browser information Recommended
timestamp ISO 8601 String the time when actor viewed the Learning Plan Required
authority Agent Object the person who viewed the Learning Plan Required
{
    "actor":{
        "objectType": "Agent",
        "name": "student",
        "account": {
            "homePage": "https://auth.ischool.com.tw/",
            "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
        }
    },
    "verb":{
        "id":"http://id.tincanapi.com/verb/viewed",
        "display":{
            "en-US":"viewed"
        }
    },
    "object":{
        "objectType":"Activity",
        "id":"http://visca.org/learning_plan/1",
        "definition":{
            "name":{
                "en-US":"Big Data Analytics"
            },
            "description":{
                "en-US":"Learn everything about Big Data"
            },
            "type":"https://w3id.org/xapi/acrossx/activities/plan",
            "extensions":{
                "https://w3id.org/xapi/acrossx/extensions/alignment":["http://visca.org/alignment/1"]                
            }
        }
    },
    "context":{
        "instructor":{
            "objectType":"Agent",
            "name":"teacher",
            "account": {
              "homePage": "https://auth.ischool.com.tw/",
              "name": "9675f710-7fcf-11e6-bdf4-0800200c9a66"
            }
        },
        "platform":"http://visca.com/planning",
        "language":"en-US",
        "contextActivities":{
            "category":[
                {
                    "objectType":"Activity",
                    "id":"https://w3id.org/xapi/acrossx/profile/learning-plan"
                }
            ]
        },
        "extensions":{
            "http://id.tincanapi.com/extension/browser-info":{ "code_name": "Mozilla", "name": "Netscape", "version": "5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "platform": "MacIntel", "user-agent-header": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.152 Safari/537.36", "cookies-enabled": true }
        }
    },
    "authority":{
      "objectType":"Agent",
      "name":"student",
      "account": {
          "homePage": "https://auth.ischool.com.tw/",
          "name": "f9e2t55c-7451-4d0b-ac3r-7201q1a6dfgf"
      }
    },
    "timestamp":"2015-09-21T05:45:34Z"
}

results matching ""

    No results matching ""