Add batch_drop_status param to SIS Import API for batchmode like diffing_drop_status in diffingmode

This idea has been developed and deployed to Canvas

For more information, please refer to the  Canvas Deploy Notes (2021-06-09).

Please add a "batch_drop_status" parameter to the SIS Imports API for batch mode that has the same functionality that the existing "diffing_drop_status" parameter has for diffing mode.

This will allow us to run a feed in batch mode which marks null enrollment rows "inactive" instead of "deleted" which will be very useful for retaining visibility of enrollment rows/roster/grades for students who drop courses after add/drop period is past. With the batch mode hard-coded to always "delete" enrollments, this functionality is impossible in batch mode.

 
 
 
8 Comments
Stef_retired
Instructure Alumni
Instructure Alumni
Status changed to: Open
 
c_waterbury
Community Explorer

This is a crucial feature needed and would allow for more robust data/insights on learners that drop courses as well! 

e_provensal
Community Participant

We need this to maintain accurate data. 

jperkins
Instructure
Instructure
Comments from Instructure

This was released in the 2021-06-09 Canvas release. The parameter is "batch_mode_enrollment_drop_status" and can be seen in our current SIS Import API documentation

Stef_retired
Instructure Alumni
Instructure Alumni
Status changed to: Completed
 
c_carrillo1
Community Participant

Wow!  Just wow!  Thank you!

One question which is not clear from the documentation--if you previously use the status "deleted" and have several enrollments already deleted, if you run a subsequent feed with a batch_mode_enrollment_drop_status of "inactive", will it mark any currently active students missing from the feed as "inactive" and leave the previously deleted enrollments alone (the desired behavior), or will it go back and change the revive the previously deleted enrollments status to "inactive", thus pulling all the previously deleted students back into visibility (the undesired behavior) ?

Thank you.

 

 
 
KristinL
Community Team
Community Team
Status changed to: New
 
KristinL
Community Team
Community Team
Status changed to: Completed