This endpoint records data about the execution of a question, task, assignement or project in the Learning Analytics Data Lake for further data analisys.

Tasks have execution stages that specify whether the task has started or ended. Those stages are represented using the action field.
Actions:

  • Started : Indicates that the student started performing the task
  • Submitted : Indicates that the student has completed the task
  • Abandoned : Indicates that the student abandoned the task without having completed it
  • Aborted : indicates that the task was compulsorily finished by time out or by any other execution condition
  • Abnormal Termination: Indicates that the task was terminated due to a technical failure in the EdTech's system

Endpoints

Production environment
POST [under construction / not available]

Sandbox
POST https://x3b54mm4ze.execute-api.us-east-1.amazonaws.com/test/task

Request structure

Header

  • Authorization : Access Token provided by the Request Token endpoint
  • Content-Type : application/json

Body
Json in Caliper API format containing task information.

Required Fields

  • actor : Identifies the student who is performing the task
  • action : Determines the stage of task execution
  • object : Identifies the learning object to which the task relates

Payload example

{
   "@context":"http://purl.imsglobal.org/ctx/caliper/v1p2",
   "id":"urn:uuid:27734504-068d-4596-861c-2315be33a2a2",
   "type":"AssessmentEvent",
   "profile":"AssessmentProfile",
   "actor":{
      "id":"https://example.edu/users/554433",
      "type":"Person"
   },
   "action":"Submitted",
   "object":{
      "id":"https://example.edu/terms/201601/courses/7/sections/1/assess/1",
      "type":"Assessment",
      "name":"Quiz One",
      "dateToStartOn":"2016-11-14T05:00:00.000Z",
      "dateToSubmit":"2016-11-18T11:59:59.000Z",
      "maxAttempts":2,
      "maxSubmits":2,
      "maxScore":25.0,
      "version":"1.0"
   },
   "generated":{
      "id":"https://example.edu/terms/201601/courses/7/sections/1/assess/1/users/554433/attempts/1",
      "type":"Attempt",
      "assignee":"https://example.edu/users/554433",
      "assignable":"https://example.edu/terms/201601/courses/7/sections/1/assess/1",
      "count":1,
      "dateCreated":"2016-11-15T10:15:00.000Z",
      "startedAtTime":"2016-11-15T10:15:00.000Z"
   },
   "eventTime":"2016-11-15T10:15:00.000Z",
   "edApp":{
      "id":"https://example.edu",
      "type":"SoftwareApplication",
      "version":"v2"
   },
   "group":{
      "id":"https://example.edu/terms/201601/courses/7/sections/1",
      "type":"CourseSection",
      "courseNumber":"CPS 435-01",
      "academicSession":"Fall 2016"
   },
   "membership":{
      "id":"https://example.edu/terms/201601/courses/7/sections/1/rosters/1",
      "type":"Membership",
      "member":"https://example.edu/users/554433",
      "organization":"https://example.edu/terms/201601/courses/7/sections/1",
      "roles":[
         "Learner"
      ],
      "status":"Active",
      "dateCreated":"2016-08-01T06:00:00.000Z"
   },
   "session":{
      "id":"https://example.edu/sessions/1f6442a482de72ea6ad134943812bff564a76259",
      "type":"Session",
      "startedAtTime":"2016-11-15T10:00:00.000Z"
   }
}

Responses

  • Code: 200
    • Status: OK
{
    "message": "Task execution stage recorded successfuly"
}
  • Code: 400
    • Status: Bad Request
{
    "message": [
           "Field <fieldname> not informed"
    ]
}
Language
Authentication
OAuth2
Authenticate
Click Try It! to start a request and see the response here!