Use Case 8 : A student enrollment was created by SIS import

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

Back to:  Table of Contents 

A student enrollment was created by SIS import

 

Use Case: Enrollments created via SIS batch job. Admin manually uploads enrollment.csv file into Canvas through SIS Import.

 

Outcome: We issue the following chain of messages for every single enrollment record in the file.

 

Event 1: enrollment_created

 

{

 "sensor": "http://www.canvaslms.com/",

 "sendTime": "2018-09-21T17:24:38.162Z",

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

 "data": [

   {

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

     "id": "urn:uuid:ab8c2244-e1a3-4504-9cb5-db57c0fb5cc3",

     "type": "Event",

     "actor": {

       "id": "urn:instructure:canvas:user:21070000000000050", //this is the ID of a newly created student, will be changing it to  ID of the person or system that created the record.

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "root_account_id": "21070000000000001",

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

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "21070000000000050"

         }

       }

     },

     "action": "Created",

     "object": {

       "id": "urn:instructure:canvas:enrollment:21070000000046823",

       "type": "Entity",

       "dateCreated": "2018-09-21T21:10:49.000Z",

       "extensions": {

         "com.instructure.canvas": {

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

           "course_section_id": "urn:instructure:canvas:course:21070000000000565:section:21070000000000598",

           "limit_privileges_to_course_section": false,

           "type": "StudentEnrollment",

           "user_id": "urn:instructure:canvas:user:21070000000000050",

           "user_name": "Student Test 4",

           "workflow_state": "active",

           "entity_id": "21070000000046823"

         }

       }

     },

     "eventTime": "2018-09-21T21:10:49.000Z",

     "edApp": {

       "id": "http://www.canvaslms.com/",

       "type": "SoftwareApplication"

     },

     "membership": {

       "id": "urn:instructure:canvas:course:21070000000000565:section:21070000000000598:user:21070000000000050",

       "type": "Membership",

       "member": {

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

         "type": "Person"

       },

       "organization": {

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

         "type": "CourseSection",

         "subOrganizationOf": {

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

           "type": "CourseOffering"

         }

       }

     },

     "extensions": {

       "com.instructure.canvas": {

         "job_id": "1020019834266239",

         "job_tag": "SisBatch.process_all_for_account",

         "version": "1.0.0"

       }

     }

   }

 ]

}

 

Event 2: enrollment state created

 

{

 "sensor": "http://www.canvaslms.com/",

 "sendTime": "2018-09-21T16:25:57.829Z",

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

 "data": [

   {

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

     "id": "urn:uuid:d15627a1-d109-4f6f-8441-16b868b874af",

     "type": "Event",

     "actor": {

       "id": "http://www.canvaslms.com/",

       "type": "SoftwareApplication"

     },

     "action": "Created",

     "object": {

       "id": "urn:instructure:canvas:enrollment:21070000000046823",

       "type": "Entity",

       "extensions": {

         "com.instructure.canvas": {

           "access_is_current": true,

           "restricted_access": false,

           "state": "active",

           "state_is_current": true,

           "entity_id": "21070000000046823"

         }

       }

     },

     "eventTime": "2018-09-21T21:10:49.000Z",

     "edApp": {

       "id": "http://www.canvaslms.com/",

       "type": "SoftwareApplication"

     },

     "extensions": {

       "com.instructure.canvas": {

         "job_id": "1020019834266239",

         "job_tag": "SisBatch.process_all_for_account",

         "version": "1.0.0"

       }

     }

   }

 ]

}

 

Event 3:  enrollment_state_updated

 

{

 "sensor": "http://www.canvaslms.com/",

 "sendTime": "2018-09-21T16:25:57.829Z",

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

 "data": [

   {

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

     "id": "urn:uuid:0ea854f3-47cd-421e-b597-2ebabe26aeb7",

     "type": "Event",

     "actor": {

       "id": "http://www.canvaslms.com/",

       "type": "SoftwareApplication"

     },

     "action": "Modified",

     "object": {

       "id": "urn:instructure:canvas:enrollment:21070000000046822",

       "type": "Entity",

       "extensions": {

         "com.instructure.canvas": {

           "access_is_current": true,

           "restricted_access": false,

           "state": "active",

           "state_is_current": true,

           "entity_id": "21070000000046822"

         }

       }

     },

     "eventTime": "2018-09-21T21:10:49.000Z",

     "edApp": {

       "id": "http://www.canvaslms.com/",

       "type": "SoftwareApplication"

     },

     "extensions": {

       "com.instructure.canvas": {

         "job_id": "1020019834266239",

         "job_tag": "SisBatch.process_all_for_account",

         "version": "1.0.0"

       }

     }

   }

 ]

}

 

Event 3: user_account_association_created

 

{

 "sensor": "http://www.canvaslms.com/",

 "sendTime": "2018-09-21T16:25:57.829Z",

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

 "data": [

   {

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

     "id": "urn:uuid:8d2fb506-9e44-420a-8a33-4b6239b11e16",

     "type": "Event",

     "actor": {

       "id": "urn:instructure:canvas:user:21070000000000050", //this is the ID of the newly created user, will be changing it to SoftwareApplication -> SIS Batch Job or at least the ID of the admin who uploaded the file.

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "root_account_id": "21070000000000001",

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

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "21070000000000050"

         }

       }

     },

     "action": "Created",

     "object": {

       "id": "urn:instructure:canvas:account:21070000000000079",

       "type": "Entity",

       "dateCreated": "2018-09-21T21:10:49.000Z",

       "dateModified": "2018-09-21T21:10:49.000Z",

       "extensions": {

         "com.instructure.canvas": {

           "is_admin": false,

           "user_id": "urn:instructure:canvas:user:21070000000000050"

         }

       }

     },

     "eventTime": "2018-09-21T21:10:49.000Z",

     "edApp": {

       "id": "http://www.canvaslms.com/",

       "type": "SoftwareApplication"

     },

     "extensions": {

       "com.instructure.canvas": {

         "job_id": "1020019834266239",

         "job_tag": "SisBatch.process_all_for_account",

         "version": "1.0.0"

       }

     }

   }

 ]

}

Back to:  Table of Contents 

Attachments

    Outcomes