xAPI Statement 101: Result Element

22 June 2016 by Ryan Smith

We’ve already talked about the Actor > Verb > Object triplet, but there can also be some other context derived from an xAPI statement as a such as the Result of the experience having occurred outside of those elements, and that’s what we’ll look at in this post.

Understanding The Result Element of an xAPI Statement

Result statements can include a number of optional details:

  • Score
    • scaled (a percentage between -1 and 1)
    • raw (the actual score)
    • min (minimum score achievable)
    • max (the maximum score achievable)
  • Success– Pass or Fail
  • Completion– Yes or No
  • Response– e.g. the actual comment/answer
  • Duration–  e.g. how long it took to complete the activity
  • Extensions– e.g. more detail about the result

An Example Result Statement Summary

A complete Result statement set up correctly will look something like this:

{

“actor”: {

“objectType”: “Agent”,

“name”: “John Smith”,

“account”: {

“name”: “123”,

“homePage”: “https://www.example.com/users/”

}

},

“verb”: {

“id”: “https://adlnet.gov/expapi/verbs/completed”,

“display”: {

“en-GB”: “completed”

}

},

“object”: {

“objectType”: “Activity”,

“id”: “https://www.example.com/activities/1”

},

“result”: {

“score”: {

“scaled”: 1,

“min”: 0,

“max”: 100,

“raw”: 100

},

“success”: true,

“completion”: true,

“response”: “Example string”,

“duration”: “P1DT12H”,

“extensions”: {

“https://www.example.com/ext”: true

}

}

}

Got it? Great!

Next up we’re looking at Context

For more practical tips and advice about the xAPI, download our Technology Managers Guide to xAPI

blank
Ryan Smith
Software Development Team Lead

Starting as a placement student in 2014, Ryan re-joined the Learning Locker team after graduating from Oxford Brookes University where he won the John Birch prize for the highest grade average in the University.

From his minimalist desk, Ryan leads the Learning Locker team and consults with people on all things xAPI to conscientiously craft products and services that sustain and evolve training and performance.

When he’s not swimming or injuring himself on the cricket field, Ryan enjoys playing funny (and usually inappropriate) games with his family.

View more from Ryan Smith
blank
Read more about Learning Pool
Visit our Learn and Connect section

Get a free demo

Get in touch to find out how we can help

Start your learning journey

Get started by telling us what you need and one of our team will be in touch very soon.