Use Case 6 : A new student enrollment is added to Canvas course section

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 new student enrollment is added to Canvas course section

Use Case: A Student is manually added to Canvas course by admin user.

Admin added Student to the course by going to People → “Add People” → add Student enrollment by Email → Student record is added to People page in “pending” state.

 

Outcome:  A number of messages were issued as a result.

 

Event 1: user_account_association_created

 

{

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

 "sendTime": "2018-09-21T13:37:11.868Z",

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

 "data": [

   {

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

     "id": "urn:uuid:d29f29fe-1c9d-40d3-bb3a-0a4cf60613d7",

     "type": "Event",

     "actor": {

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

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "user_login": "oxana",

           "root_account_id": "21070000000000001",

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

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "111111111111111"

         }

       }

     },

     "action": "Created",

     "object": {

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

       "type": "Entity",

       "dateCreated": "2018-09-21T19:38:56.000Z",

       "dateModified": "2018-09-21T19:38:56.000Z",

       "extensions": {

         "com.instructure.canvas": {

           "is_admin": false,

           "user_id": "urn:instructure:canvas:user:21070000000000047"

         }

       }

     },

     "eventTime": "2018-09-21T19:38:56.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: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": "0cb0425a-b634-48ed-a420-fa887553fbeb",

         "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"

       }

     }

   }

 ]

}

 

Event 2: enrollment_created

 

{

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

 "sendTime": "2018-09-21T13:21:03.620Z",

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

 "data": [

   {

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

     "id": "urn:uuid:33c50ce6-e219-418b-9f60-cbe182cf8626",

     "type": "Event",

     "actor": {

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

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "user_login": "oxana",

           "root_account_id": "21070000000000001",

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

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "111111111111111"

         }

       }

     },

     "action": "Created",

     "object": {

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

       "type": "Entity",

       "dateCreated": "2018-09-21T19:38:56.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:21070000000000047",

           "user_name": "Student Test 1",

           "workflow_state": "invited",

           "entity_id": "21070000000046821"

         }

       }

     },

     "eventTime": "2018-09-21T19:38:56.000Z",

     "edApp": {

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

       "type": "SoftwareApplication"

     },

     "group": {

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

       "type": "CourseSection",

       "extensions": {

         "com.instructure.canvas": {

           "context_type": "Course",

           "entity_id": "21070000000000565"

         }

       }

     },

     "membership": {

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

       "type": "Membership",

       "member": {

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

         "type": "Person"

       },

       "organization": {

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

         "type": "CourseSection",

         "subOrganizationOf": {

           "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": "0cb0425a-b634-48ed-a420-fa887553fbeb",

         "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"

       }

     }

   }

 ]

}

 

Event 3: enrollment_state_created

 

{

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

 "sendTime": "2018-09-21T16:28:12.959Z",

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

 "data": [

   {

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

     "id": "urn:uuid:c5f48769-6c02-440b-8d62-22f0ce630278",

     "type": "Event",

     "actor": {

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

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "user_login": "oxana",

           "root_account_id": "21070000000000001",

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

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "111111111111111"

         }

       }

     },

     "action": "Created",

     "object": {

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

       "type": "Entity",

       "extensions": {

         "com.instructure.canvas": {

           "access_is_current": true,

           "restricted_access": false,

           "state": "invited",

           "state_is_current": true,

           "entity_id": "21070000000046821" //enrollment ID

         }

       }

     },

     "eventTime": "2018-09-21T19:38:56.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: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": "0cb0425a-b634-48ed-a420-fa887553fbeb",

         "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"

       }

     }

   }

 ]

}

 

Event 4: enrollment_state_updated

 

//note that nothing was updated for this enrollment by the user; it is still a part of the same `create a new enrollment` use case. it looks like this message is duplicating info that was provided in  enrollment_state_created message.

 

{

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

 "sendTime": "2018-09-21T15:35:54.905Z",

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

 "data": [

   {

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

     "id": "urn:uuid:852073cf-608a-4700-95a2-01c616006cde",

     "type": "Event",

     "actor": {

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

       "type": "Person",

       "extensions": {

         "com.instructure.canvas": {

           "user_login": "oxana",

           "root_account_id": "21070000000000001",

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

           "root_account_uuid": "VicYj3cu5BIFpoZhDVU4DZumnlBrWi1grgJEzADs",

           "entity_id": "111111111111111"

         }

       }

     },

     "action": "Modified",

     "object": {

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

       "type": "Entity",

       "extensions": {

         "com.instructure.canvas": {

           "access_is_current": true,

           "restricted_access": false,

           "state": "invited",

           "state_is_current": true,

           "entity_id": "21070000000046821"

         }

       }

     },

     "eventTime": "2018-09-21T19:38:56.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: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": "0cb0425a-b634-48ed-a420-fa887553fbeb",

         "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"

       }

     }

   }

 ]

}

Back to:  Table of Contents 

Attachments

    Outcomes