Version: Next

Event Reads

When the learner reads/views a learning resource, we need to send an event to demonstrate that, we advise you also to mention the objective this object is associated with. The API calls it an Event of type Read, that can be created using the following route:

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

Here is a json input example:

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

Standard Format

The preferred standard format 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

info

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