Version: Next

Event Reviews

When the learner interacts with a Review, you need to use the following route:

Method : POST​
URL : HOST_URL/instances/{instance_id}/events
Standard Format

The preferred standard format when sending Events is xAPI which is a new specification for learning technology that makes it possible to collect data about the wide range of experiences a person has (online and offline). More info on that can be found here - Link

Review Question

To send the result of the learner answer concerning the Question, the input body will look like this:

{​
"student_id": 3,​
"content_id": 4,
"event_type": "EventReview",​
"standard": "xAPI",​​
"payload": {
"actor": {
"mbox": "mailto:example@example.com",
"objectType": "Agent"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/answered"
},
"object": {
"id": "29d943ca-fb8f-4e85-ace4-cec8e157ba78",
"objectType": "ContentEvaluation"
}
"result": {
"score": {
"scaled": 1
},
"success": true
}
}
}

Review Action

When the learner is receiving a Review Action, he has to decide if he accepts or declines the Action.

Accepts an Action

If he accepts the Review Action, the input body will look like this:

{​
"student_id": 3,​
"content_id": 5,
"event_type": "EventReview",​
"standard": "xAPI",​​
"payload": {
"actor": {
"mbox": "mailto:example@example.com",
"objectType": "Agent"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/accepted"
},
"object": {
"id": "29d943ca-fb8f-4e85-ace4-a488e157ba78",
"objectType": "ContentAction"
},
"result": {
"delay_for_action": 10
}
}
}

As you can see in the request above, you can enter a delay for performing the action (here 10 days). After these 10 days, if no performing Event is received another Review will be triggered for the learner.

Declines an Action

If he declined the Review Action, the input is then:

{​
"student_id": 3,​
"content_id": 5,
"event_type": "EventReview",​
"standard": "xAPI",​​
"payload": {
"actor": {
"mbox": "mailto:example@example.com",
"objectType": "Agent"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/declined"
},
"object": {
"id": "29d943ca-fb8f-4e85-ace4-a488e157ba78",
"objectType": "ContentAction"
}
}
}

When declining a ReviewAction, another review will also be triggered for the learner.

Performs an Action

To send a perfoming Event, the request will look like this:

{​
"student_id": 3,​
"content_id": 5,
"event_type": "EventReview",​
"standard": "xAPI",​​
"payload": {
"actor": {
"mbox": "mailto:example@example.com",
"objectType": "Agent"
},
"verb": {
"id": "http://adlnet.gov/expapi/verbs/performed"
},
"object": {
"id": "29d943ca-fb8f-4e85-ace4-a488e157ba78",
"objectType": "ContentAction"
},
"result": {
"score": {
"scaled": 1
},
"success": true
}
}
}
info

A more detailed documentation on how to send events can be found here - Link