Get all students for current term

[rancho]

Hello

I am trying to get all the students for the current term.  I tried to run the SIS export for users, but that did not include their canvas ids.  So I thought I would use the api.  I get back the approximate number, but none of the students in a class are there.  Here is how I did it.  First I got the current term like so.

https://XXX.com/api/v1/accounts/self/terms/current

that returned 150 for the term number so I used that in the list the users call

https://XXX.com/api/v1/accounts/self/users?search_term=150&enrollment_type=student&per_page=200

And I had to page a while.  Like I said I got back 6500 students, but it does not seem like I am getting all of them.

Any ideas or suggestions appreciated.

cheers

bob

[dgrobani]

As it says at the bottom of the SIS Export report dialog box, "*Term settings only impact Courses, Sections, Enrollments, and X list CSV files." Instead of selecting Users, try selecting Enrollments.

You can use an SIS ID instead of a Canvas ID in most API calls. Check out Object IDs, SIS IDs, and special IDs - Canvas LMS REST API Documentation.

[dgrobani]

Also, to get all students for a term via the API, you can List active courses in an account, specifying the enrollment_term_id parameter, and then List enrollments for each course, specifying the enrollment_type[] parameter.

[rancho]

dgrobani

Thanks for your feed back.  I thought about using that idea, but I was hoping to find a distinct list of student names and their canvas and login ids. 

And not being real familiar with the API, I assumed the search_term was the  enrollment_term_id.

Thanks again for your feed back.

cheers

bob

[matthew_buckett · Accepted solution]

@rancho If you use the Provisioning Report, rather than the SIS Export then you will get the Canvas IDs of the users included in the export.

I don't think you can use the `search_term` parameter to search for users who just have enrolments in a term with an ID of 150. Looking at the documentation: https://canvas.instructure.com/doc/api/users.html#method.users.api_index it says about the search_term:

---

---

The partial name or full ID of the users to match and return in the results list. Must be at least 3 characters.

Note that the API will prefer matching on canonical user ID if the ID has a numeric form. It will only search against other fields if non-numeric in form, or if the numeric value doesn't yield any matches. Queries by administrative users will search on SIS ID, login ID, name, or email address

---

So I expect it's matching "150" in a different ID on the user and not in the term associated with the user's enrolments on courses.

[rancho]

Good Morning @matthew_buckett 

Thanks for the reply.  I am always in a hurry and need to slow down.  I did not read what the search_term was.  I had just assumed it was the school term, duh.

And thanks for the tip about the Provisioning Report I will give that a try.  I used the api yesterday to list out all the users.  And that took over 30 minutes at 200/page.  So the report will have to be faster.

And thanks to all that help out.

cheers

bob