What's sis_import_id for?

Jump to solution
jlubkinchavez
Community Contributor

I'm working on integrating Canvas with another system, and I'd like to bring back an enrollment record ID from the other system and put it on the Canvas enrollment. Is sis_import_id an appropriate place, or is that supposed to be used for something else (and if so what)?  Forgive my ignorance—I'm not a developer (using an iPaaS), and the other objects all have clearcut names (sis_user_id, sis_course_id, sis_section_id).

Labels (1)
0 Likes
1 Solution
matthew_buckett
Community Contributor

The sis_import_id on the enrollment object (https://canvas.instructure.com/doc/api/enrollments.html) is used to show which SIS Import created (updated?) the enrollment. You can use this ID to look the SIS Import using https://canvas.instructure.com/doc/api/sis_imports.html#method.sis_imports_api.show

This is useful in debugging issues as it allows you to find the set of CSV files that were used to create a record in Canvas and then tie that to a external process that might have a problem.

View solution in original post