cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
glparker
Community Champion

Enrollments API list order, recent change from sortable_name to ???

Jump to solution

Good Morning,

Basically forever, this particular API call would return users in order by their sortable name
https://usflearn.instructure.com/api/v1/courses/sis_course_id:EVR2001.003U21/enrollments?role=Studen...


However, within the last few days, this API call is now returning the users in a seemingly arbitrary order. The order is consistent among multiple calls to the API, as long as the population in the course is the same, the order of the students seems to always be the same, but in an unstructured order.

All of our applications that load enrollments were replying on this sort ordering, and now our applications are displaying the students in whatever order, highly disruptive to the teachers using our applications.  

Were there any changes to the Enrollments endpoint recently?   I didn't see any listed in the change log, (but if we were relying on an undocumented feature, that's not surprising).   If there was a change, and chance it could be reverted or an explicit sort added to the output?

If this was a planned change, do you have any suggestions for how we can make the API call and request the results in sortable order?   Is there an API query option to request a particular ordering to the results?

1 Solution

Accepted Solutions
leward
Community Contributor

We created a ticket about this on July 8 and we're still waiting for a reply.  When I hear back, I'll update this group.  

View solution in original post

0 Kudos
3 Replies
glparker
Community Champion

I don't have enough data to say for sure, but in these API queries, it looks like the records are being returned ordered by their enrollment_id (id)

"id": 35353741, "sortable_name": "Hogrell, John",
"id": 35357751, "sortable_name": "Bethel, Johnny",
"id": 35365449, "sortable_name": "Oliver, Findlay",
"id": 35368163, "sortable_name": "Eliga, Joslyn",
"id": 35368597, "sortable_name": "Orehek, Simon",
"id": 35370519, "sortable_name": "Pena, Micaela",
"id": 35373201, "sortable_name": "Ostler, Jacob",
"id": 35376037, "sortable_name": "Thompson, Rylee",
"id": 35378627, "sortable_name": "Ibragimov, Azim",
"id": 35410815, "sortable_name": "Brady, Morgan",
"id": 35415895, "sortable_name": "Ferguson, Angus",
"id": 35418371, "sortable_name": "Bohren, Jacob",
"id": 35422587, "sortable_name": "Bermudez-Quinones, Shirleann",
"id": 35444731, "sortable_name": "More, Shelbi",

 

Seems like someone added/changed an order by in the underlying query recently. . .  

 
 
agschmid
Community Contributor

We discovered this same issue yesterday and the only thing I found was the in the Canvas Deploy Logs - changes made to the Gradebook CSV column order: https://community.canvaslms.com/t5/Canvas-Deploys/Canvas-Deploy-Notes-2021-07-07/ta-p/470518

leward
Community Contributor

We created a ticket about this on July 8 and we're still waiting for a reply.  When I hear back, I'll update this group.  

View solution in original post

0 Kudos