LmsApi :: moduleData

moduleData

Properties:

id: Corresponds to a Verb definition. Each Verb definition corresponds to the meaning of a Verb, not the word. The IRI should be human-readable and contain the Verb meaning.
display: The human readable representation of the Verb in one or more languages. This does not have any impact on the meaning of the Statement, but serves to give a human-readable display of the meaning already determined by the chosen Verb.

Verb Meaning:

Usage: Retrieve and store contextual data in a JSON format.
Use statement objects for communication.

JSON Representation:

Get ModuleData Request:

{
	"verb": {
		"id": "http://bao.mijnklas.nl/xapi/verbs/moduleData",
		"display": {
			"nl-NL": "Contextuele gegevens"
		}
	},
	"object": {
		"id": "http://bao.mijnklas.nl/xapi/activities/get-moduledata-request",
		"objectType": "Activity"
	}
}

Get ModuleData Response:

{
	"verb": {
		"id": "http://bao.mijnklas.nl/xapi/verbs/moduleData"
	},
	"object":{
		"id":"http://bao.mijnklas.nl/xapi/activities/get-moduledata-response",
		"objectType":"Activity"
	},
	"result": {
		"duration": "PT3S",
		"extensions": {
			"http://bao.mijnklas.nl/xapi/extensions/objectType": "json",
			"http://bao.mijnklas.nl/xapi/extensions/json": "{interaction: '3C47A135-92C0-4043-B6F0-28A48D64B67E', answer: 123}" /* {interaction: '3C47A135-92C0-4043-B6F0-28A48D64B67E', answer: 123} is an example JSON string. */
		}
	}
}

Set ModuleData Request:

{
	"verb": {
		"id": "http://bao.mijnklas.nl/xapi/verbs/moduleData",
		"display": {
			"nl-NL": "Contextuele gegevens"
		}
	},
	"object": {
		"id": "http://bao.mijnklas.nl/xapi/activities/set-moduledata-request",
		"objectType": "Activity",
		"definition": {
			"extensions": {
				"http://bao.mijnklas.nl/xapi/extensions/objectType": "json",
				"http://bao.mijnklas.nl/xapi/extensions/json": "{interaction: '3C47A135-92C0-4043-B6F0-28A48D64B67E', answer: 123}" /* {interaction: '3C47A135-92C0-4043-B6F0-28A48D64B67E', answer: 123} is an example JSON string. */
			}
		}
	}
}

Set ModuleData Response:

{
	"verb": {
		"id": "http://bao.mijnklas.nl/xapi/verbs/moduleData"
	},
	"object":{
		"objectType":"Activity",
		"id":"http://bao.mijnklas.nl/xapi/activities/set-moduledata-response"
	},
	"result": {
		"duration": "PT3S",
		"response": "stored" /* Can be either 'stored' of 'failed', indicating wether storage of contextual data succeeded or not. */
	}
}

Legend:

Different colors in the JSON Representation give special meaning to that part of the json.

Optional: May be added for clarity. Bao xApi ignores it if present.

~~Removed:~~ Bao xApi has no use for it but TinCan Api requests/requires it. Bao xApi ignores it if present.

Comment: Comment for clarification of the property. This should not be present in the json representation

;