Enrollments API - inactive status?

[Midiman]

Under the "Enrollments" API documentation there's an 'inactive' status:

https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index

What exactly does 'inactive' mean? Is this something that can be had via the UI or can someone's enrollment status be changed to 'inactive' only via an SIS integration?

[Rob Orton]

It is a way to say the student has not paid and will not have full access to the course.  It is similar impact to the user if the course has not started (has not passed the start_at date) and they don't have access to it yet.

-Rob

[Midiman]

Thanks, Rob...

I'm looking at some potential functionality to set an enrollment in a course such that the student data associated with the course is still present in the system but the student is in the following state:

• Student doesn't have access to a course that has started
• Student data doesn't contribute to analytics
• Student data can be retrieved by temporarily setting their status back to 'active' or 'completed/concluded' and then set back to 'inactive' or something similar

My experience is that setting a student to 'completed' leaves the student data such that it contributes to analytics, and I would rather have a way to detach a student enrollment from a course in a way such that it does NOT contribute to analytics and such that the student does NOT have any access to the course.

Is this even possible?

[Rob Orton]

From what I can tell Analytics is looking at enrollments that are in a state of active or completed/concluded, so I believe inactive would work for you. 

I don't believe the state has been used much at all, so I would recommend doing some testing to make sure you are getting the results you would expect. 

-Rob

[Midiman]

Thanks, Rob

Does this mean that using the following method of concluding a student enrollment would work via the API?

curl https://<canvas>/api/v1/courses/:course_id/enrollments/:enrollment_id \ 
  -X DELETE \ 
  -F 'task=inactive'

I'll give it a try, but in the meantime I wanted to ask since it's not officially in the API docs that this is possible.

[Rob Orton]

No, the delete method will only handle conclude and delete. It looks like this can only be done through an SIS import at the moment.

-Rob

[Midiman]

Yes, I just found that out...no on the API method, but yes on SIS import.  Thanks for the information on the status!

[David Pinto]

Ever since the beginning of our Canvas use, I've asked for a "Hold" functionality, where the student data exists in the course but the student is no longer allowed to log in.  It's only been three years and Canvas can't implement this rather simple concept that Angel did so well.

--

---
You received this message because you are subscribed to the Google Groups "Canvas LMS Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to canvas-lms-use...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Eric Korb]

Agreed!  I placed this on the wish list in the suggestion box over 2 years go too.