object
specifies the details of the content that is requested.
The customContent verb supports several different Objects. The following Object IDs are supported. Each Object may define their own Extensions.
All extensions are a single key-value pair. The key is http://bao.mijnklas.nl/xapi/activities/«MODULE»
where «MODULE» is identical to the last part of the Object id. The value is a JSON object.
This object is used by the MijnKlas Tables modules. It requires the following configuration in the Extensions object:
{
"http://bao.mijnklas.nl/xapi/extensions/contentTables": {
"localeCode": "nl-NL",
// Format of the expected equations, where 'n' should be a number
// between 0 and 10 (exclusive) and determines which multiplication table to use.
//
// For example: {1..10}*{2}={1..100} would generate equations for the 2 Times Table
// such as 1 * 2 = 2, 2 * 2 = 4, etc.
"definition": "{1..10}*{n}={1..100}",
// Indicates which position in the equation the user should fill in. Should be set to "4".
// Example: for equations such as 3 * 2 = 6, the user needs to answer 3 * 2 = ?, and provide "6" as the answer.
"hiddenvalues": "4",
// Should be set to "false"
"israndomcollection": "false",
// Indicates the number of equations to generate. Should be set to "10"
"numberofitemstogenerate": "10",
// Should be set to "0"
"numberofwrongitems": "0",
// Should be set to "false"
"variablesareunique": "false"
}
}
{
"http://bao.mijnklas.nl/xapi/extensions/contentExample": {
"key": "value",
"otherKey": "otherValue"
}
}
{
"verb": {
"id": "http://bao.mijnklas.nl/xapi/verbs/customContent",
"display": {
"nl-NL": "Inhoud"
},
"object": {
"id": "http://bao.mijnklas.nl/xapi/activities/«object»",
"objectType": "Activity",
"definition": {
"extensions": {
"http://bao.mijnklas.nl/xapi/extensions/«object»": {
"key": "value"
// ..
// ..
}
}
}
}
}
}
Response example:
{ // TODO // .. }
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