xAPI Statement

xAPI Statement

by Michael Munoz

1. only *1* IFI

1.1. "mbox": "mailto:[email protected]"

1.2. "mbox_sha1sum": "gibberish"

1.3. "openid": "yourOpenID"

1.4. "account": { "homepage": "homepage.com" "account": "AccountName" }

2. "actor"{ };

2.1. group

2.1.1. Anonymous

2.1.1.1. "objectType": "Group"

2.1.1.2. "member": "array, of, agent, objects"

2.1.1.3. "name": "Group Name"

2.1.2. Identified

2.1.2.1. "objectType": "Group"

2.1.2.2. IFI

2.1.2.3. "name": "Group Name"

2.1.2.4. "member": "array, of, agent, objects"

2.2. agent

2.2.1. IFI

2.2.2. "objectType": "agent"

2.2.3. "name": "User Name"

3. "verb" { };

3.1. "id": "https://registry.tincanapi.com/"

3.2. "display": { "en-US": "verbiage" }

4. "object" { };

4.1. statement reference

4.1.1. "objectType": "StatementRef"

4.1.2. "id": "uuid gibberish"

4.2. activity

4.2.1. "id": "http://some.iri/activity"

4.2.2. "objectType": "Activity"

4.2.3. "definition": { }

4.2.3.1. "name": { "en-US": "visual/human readable name of activity" }

4.2.3.2. "description": { "en-US": "description of activity" }

4.2.3.3. "type": "https://registry.tincanapi.com/#"

4.2.3.4. "moreInfo": "http://some.iri/moreInfo.html"

4.2.3.5. "extensions": { }

4.2.3.5.1. rabbit hole...

4.2.3.6. "interactionType":

4.2.3.6.1. "true-false", "choice", "likert", "sequencing", "choice", "fill-in", "long-fill-in", "performance", "numeric", "matching", "other"

4.2.3.6.2. correctResponsesPattern: [ "1", "2", "3" ]

4.2.3.6.3. "choices", "scale", "steps", ["source", "target"]

4.3. agent

4.3.1. IFI

4.3.2. "objectType": "agent"

4.3.3. "name": "User Name"

4.4. SubStatements

4.4.1. danger... recursion imminent

5. "result" { };

5.1. "completion": true/false

5.2. "success": true/false

5.3. "response": "saved as a string"

5.4. "duration": iso time gibberish

5.5. "scored": { }

5.5.1. "raw": 100

5.5.2. "min": 0

5.5.3. "max": 100

5.5.4. "scaled": -1 to 1

5.6. "extensions": { any JSON value/data }

6. "context" { };

6.1. "registration": "uuid"

6.2. "instructor": { agent object }

6.3. "team": { group object }

6.4. "platform": "social media platform"

6.5. "statement": { }

6.5.1. "objectType": "StatementRef"

6.5.2. "id": "uuid"

7. "timestamp": iso time gibberish

8. "authority"

8.1. set by LRS if not generated by LRP

9. "attachments"

10. "stored"

10.1. set by LRS

11. use of JSON intended to be helpful for those bent on generating their own xAPI statements. They are, however, not exhaustive and you should always refer to the official spec when in doubt.

12. REQUIRED

13. Optional

14. "id"

14.1. set by LRS if not generated by LRP

15. Recommended

16. Set by LRS

17. descriptive labels