Payload: OutcomeEvent

Document created by Oxana Jurosevic Administrator on Oct 17, 2018Last modified by Oxana Jurosevic Administrator on Oct 17, 2018
Version 3Show Document
  • View in full screen mode

Back to:  Table of Contents 

OutcomeEvent

 

grade_changed

 

{

 "sensor": "http://oxana.instructure.com/",

 "sendTime": "2018-09-19T21:08:14.793Z",

 "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",

 "data": [

   {

     "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",

     "id": "urn:uuid:a9c6d773-8da6-4b82-976a-844f9364f41a",

     "type": "GradeEvent",

     "actor": {

       "id": "urn:instructure:canvas:user:111111111111111",

       "type": "Person" // you will see auto-graded quizzes with actor = SoftwareApplication

     },

     "action": "Graded",

     "object": {

       "id": "urn:instructure:canvas:submission:21070000000011086",

       "type": "Attempt",

       "extensions": {

         "com.instructure.canvas": {

           "grade": "2",

           "entity_id": "21070000000011086"

         }

       },

       "assignee": {

         "id": "urn:instructure:canvas:user:21070000000000048",

         "type": "Person",

         "extensions": {

           "com.instructure.canvas": {

             "sis_id": "Test2"  //student_sis_id

           }

         }

       },

       "assignable": {

         "id": "urn:instructure:canvas:assignment:21070000000000355",//assignment_id

         "type": "AssignableDigitalResource"

       }

     },

     "eventTime": "2018-09-19T22:42:41.000Z",

     "generated": {

       "id": "urn:instructure:canvas:submission:21070000000011086",

       "type": "Score",

       "extensions": {

         "com.instructure.canvas": {

           "grade": "2", //submission grade

           "entity_id": "21070000000011086" //submission id

         }

       },

       "attempt": {

         "id": "urn:instructure:canvas:submission:21070000000011086",

         "type": "Attempt",

         "extensions": {

           "com.instructure.canvas": {

             "grade": "2" //submission grade

           }

         },

         "assignee": {

           "id": "urn:instructure:canvas:user:21070000000000048",

           "type": "Person",

           "extensions": {

             "com.instructure.canvas": {

               "sis_id": "Test2" //student_sis_id

             }

           }

         },

         "assignable": {

           "id": "urn:instructure:canvas:assignment:21070000000000355",//assignment_id

           "type": "AssignableDigitalResource"

         }

       },

       "maxScore": {

         "numberStr": "1.0" // points_possible

       },

       "scoreGiven": {

         "numberStr": "2.0"  // submission score

       },

       "scoredBy": "urn:instructure:canvas:user:111111111111111"

     },// grader_id should be an Agent of who graded the submission, where agent might be the system.

     "edApp": {

       "id": "http://oxana.instructure.com/",

       "type": "SoftwareApplication"

     },

     "group": {

       "id": "urn:instructure:canvas:course:21070000000000565",

       "type": "CourseOffering",

       "extensions": {

         "com.instructure.canvas": {

           "context_type": "Course",

           "entity_id": "21070000000000565"

         }

       }

     },

     "membership": {

       "id": "urn:instructure:canvas:course:21070000000000565:user:111111111111111",

       "type": "Membership",

       "member": {

         "id": "urn:instructure:canvas:user:111111111111111",

         "type": "Person"

       },

       "organization": {

         "id": "urn:instructure:canvas:course:21070000000000565",

         "type": "CourseOffering"

       }

     },

     "session": {

       "id": "urn:instructure:canvas:session:fe03cd7d1de8d27ca95e2d6f5fe11891",

       "type": "Session"

     },

     "extensions": {

       "com.instructure.canvas": {

         "hostname": "oxana.instructure.com",

         "request_id": "3d1c2f66-3a30-4a27-b82e-509f2e4f0780",

         "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36",

         "version": "1.0.0"

       }

     }

   }

 ]

}

 

Supported Extensions:

 

Extensions (grade_changed)

assignee:

extensions:

    sis_id: student_sis_id

 

generated.extensions:         

grade: grade,

entity_id: submission_id

 

 

 

 

submission_created: basic canvas assignment

 

{

 "sensor": "http://oxana.instructure.com/",

 "sendTime": "2018-09-20T19:22:18.779Z",

 "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",

 "data": [

   {

     "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",

     "id": "urn:uuid:cd900847-7b3b-4fc0-b672-153113a69b5f",

     "type": "AssignableEvent",

     "actor": {

       "id": "urn:instructure:canvas:user:21070000000000048",

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "real_user_id": "111111111111111",

           "user_login": "test2@test.com",

           "root_account_id": "21070000000000001",

           "root_account_lti_guid": "7db438071375c02373713c12c73869ff2f470b68.oxana.instructure.com",

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "21070000000000048"

         }

       }

     },

     "action": "Submitted",

     "object": {

       "id": "urn:instructure:canvas:submission:21070000000011091",

       "type": "Attempt",

       "dateCreated": "2018-09-20T22:17:58.000Z", //uses updated_at timestamp, it looks like Canvas events are coming with updated_at attribute ? at the moment updated_at is the same value as created_at for all new submissions, but still need to update it with created_at if anything changes in Canvas where we are using correct timestamp. 

       "extensions": {

         "com.instructure.canvas": {

           "submission_type": "online_text_entry", // submission type (see all types in Canvas API)

           "entity_id": "21070000000011091" //submission_id

         }

       },

       "assignee": {

         "id": "urn:instructure:canvas:user:21070000000000048",

         "type": "Person"

       },

       "assignable": {

         "id": "urn:instructure:canvas:assignment:21070000000000360",

         "type": "AssignableDigitalResource"

       },

       "count": 1, //attempt count

       "body": "<p>this is a test assignment</p>"

     },

     "eventTime": "2018-09-20T22:17:58.000Z",

     "edApp": {

       "id": "http://oxana.instructure.com/",

       "type": "SoftwareApplication"

     },

     "group": {

       "id": "urn:instructure:canvas:course:21070000000000565",

       "type": "CourseOffering",

       "extensions": {

         "com.instructure.canvas": {

           "context_type": "Course",

           "entity_id": "21070000000000565"

         }

       }

     },

     "membership": {

       "id": "urn:instructure:canvas:course:21070000000000565:Learner:21070000000000048",

       "type": "Membership",

       "member": {

         "id": "urn:instructure:canvas:user:21070000000000048",

         "type": "Person"

       },

       "organization": {

         "id": "urn:instructure:canvas:course:21070000000000565",

         "type": "CourseOffering"

       },

       "roles": [

         "Learner"

       ]

     },

     "session": {

       "id": "urn:instructure:canvas:session:fe03cd7d1de8d27ca95e2d6f5fe11891",

       "type": "Session"

     },

     "extensions": {

       "com.instructure.canvas": {

         "hostname": "oxana.instructure.com",

         "request_id": "e17ec787-8899-47a7-8665-9b5f51849e40",

         "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36",

         "version": "1.0.0"

       }

     }

   }

 ]

}

 

Supported Extensions:

 

Extensions (submission_created)

  submission_type: submission_type,

       url: url,

       entity_id: submission_id

 

submission updated: basic canvas assignment

 

{

 "sensor": "http://oxana.instructure.com/",

 "sendTime": "2018-09-20T16:28:02.309Z",

 "dataVersion": "http://purl.imsglobal.org/ctx/caliper/v1p1",

 "data": [

   {

     "@context": "http://purl.imsglobal.org/ctx/caliper/v1p1",

     "id": "urn:uuid:af121828-193b-487e-af13-9b48de52e216",

     "type": "Event",

     "actor": {

       "id": "urn:instructure:canvas:user:21070000000000048",

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "real_user_id": "111111111111111",

           "user_login": "test2@test.com",

           "root_account_id": "21070000000000001",

           "root_account_lti_guid": "7db438071375c02373713c12c73869ff2f470b68.oxana.instructure.com",

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "21070000000000048"

         }

       }

     },

     "action": "Modified",

     "object": {

       "id": "urn:instructure:canvas:submission:21070000000011091",

       "type": "Attempt",

       "dateModified": "2018-09-20T22:23:25.000Z", // submission updated_at date

       "extensions": {

         "com.instructure.canvas": {

           "submission_type": "online_text_entry",

           "entity_id": "21070000000011091"

         }

       },

       "assignee": {

         "id": "urn:instructure:canvas:user:21070000000000048",

         "type": "Person"

       },

       "assignable": {

         "id": "urn:instructure:canvas:assignment:21070000000000360",

         "type": "AssignableDigitalResource"

       },

       "count": 2, //number of attempts

       "body": "<p>This is a re-submitted assignment</p>"

     },

     "eventTime": "2018-09-20T22:23:25.000Z",

     "edApp": {

       "id": "http://oxana.instructure.com/",

       "type": "SoftwareApplication"

     },

     "group": {

       "id": "urn:instructure:canvas:course:21070000000000565",

       "type": "CourseOffering",

       "extensions": {

         "com.instructure.canvas": {

           "context_type": "Course",

           "entity_id": "21070000000000565"

         }

       }

     },

     "membership": {

       "id": "urn:instructure:canvas:course:21070000000000565:Learner:21070000000000048",

       "type": "Membership",

       "member": {

         "id": "urn:instructure:canvas:user:21070000000000048",

         "type": "Person"

       },

       "organization": {

         "id": "urn:instructure:canvas:course:21070000000000565",

         "type": "CourseOffering"

       },

       "roles": [

         "Learner"

       ]

     },

     "session": {

       "id": "urn:instructure:canvas:session:fe03cd7d1de8d27ca95e2d6f5fe11891",

       "type": "Session"

     },

     "extensions": {

       "com.instructure.canvas": {

         "hostname": "oxana.instructure.com",

         "request_id": "f9fd3ccb-290e-4908-8a55-435a8f1d0d43",

         "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36",

         "version": "1.0.0"

       }

     }

   }

 ]

}



Supported Extensions:

 

Extensions (submission_updated)

          submission_type: submission_type,

    url: url,

    entity_id: submission_id

Back to:  Table of Contents 

Attachments

    Outcomes