[ARCHIVED] SIS Import via API not respecting "Completed" status

[bmerkel]

Some weird things just started happening yesterday with our SIS update via API. See below for a copy of what we sent to Tier 1.

Anyone else seeing this?

"I believe there is a problem with the API upload of our SIS CSVs

For the past 5+ years, our daily CSVs have used the status "completed" to designate student withdraws. This has worked great because it hides them in the gradebook and roster but maintains their data on the back end.

This week it seems like CSVs uploaded via the API aren't recognizing "completed" and reverting them to active.

I have several feed files that have been uploaded with that status and when I pull a provisioning report to check to see that it was worked, those same enrollments have an active status.

What is weirder is that when I take that same enrollment CSV and upload it through the SIS Imports tab on the front-end (not upload via API) those that are marked "completed" behave as expected. They are removed from view and you can see them under "past enrollments".

However, the next scheduled feed that runs via the API with those statuses as "completed" reverts them back to active.

As far as I can see this just started happening yesterday.

Also, for what it's worth, when I download a complete provisioning report for every past term... I don't see any "completed" statuses from past terms. This is a big problem because we have several processes that depend on us being able to tell the difference between a student dropping a class ("deleted") and a student withdrawal ("completed")."

[mzimmerman]

I don't have any insight into what may be happening via the API, but w have always used the "unavailable" setting for students who have dropped or withdrawn after the the class has begun.  "Completed" continues to give students access to the course in read-only mode (according to the docs at https://canvas.instructure.com/doc/api/file.sis_csv.html ) and that's not what we want for students who are no longer enrolled.

[bmerkel]

See that's what is confusing. According to this document, what you describe is under "Concluded". Historically, we have used "completed" and it doesn't go into read only. It's weird to see such a disconnect in the terminology between the API and front end.

[mzimmerman]

My guess is that the correct value is supposed to be "concluded", not "completed", especially since that corresponds with the "Conclude" naming convention on the user screen for the person within the People section of  the class:

I also not that the document you referenced does not refer to "completed" as a valid status for an enrollment, either.

[bmerkel]

But it does say that, that's why it's so confusing. In the second paragraph of that document: "When updating an enrollment status via CSV, the status can be set to active, deleted, completed, inactive, or deleted_last_completed. "

Regardless, it's strange that it recognizes completed and inactive statuses when uploading through the GUI but doesn't recognize either uploading via the API.

[JeffW · Accepted solution]

Hi @bmerkel 

I definitely see the confusion in the wording for those two sets of documentation.

If you look specifically at the API documentation for updating enrollments (rather than csv), you will see that it references the status of "conclude" rather than a state of completed which would work with a csv upload. - https://canvas.instructure.com/doc/api/enrollments.html

I singled out that info in the attached screenshot, I hope that is helpful in explaining the difference. For a more technical understanding I recommend continuing to work with Canvas Support as you mentioned you had submitted a request.