How to download a course roster with group membership

[baldus]

Hi everyone,

I'm looking for a way to download the course roster with group membership identified for each student (e.g., a column in the spreadsheet that contains the group number/name).  I have heard that this data can be pulled through the API and I was wondering if anyone could help me find out how that is possible.  Any suggestions?

Thanks in advance for your help!

[ericwerth]

Hi  @baldus .  I can't answer your question, but in addition to this location I am also going to share this question with the https://community.canvaslms.com/groups/canvas-developers?sr=search&searchId=3fe0c7e8-a405-44a7-9b3e-...‌ user group.  I know that many members of this group work with LTI and/or API integrations, so perhaps one of these individuals will be able to assist.

Best wishes!

[kona]

 @baldus ‌, I haven’t personally used this before, but I think it might be similar to what you are wanting for - Automated report of group sets, groups and members in a course.

I hope it helps or at least gets you on the right track!

Kona

[gtaylor · Accepted solution]

Using the API to do this would work like this:

The groups piece would be 2 calls.

List the groups available in a context.

GET /api/v1/courses/:course_id/groups

This will give you a list of groups for a course.

Then you plug in the ID to get the Group Memeber ship.

List Group membership

GET /api/v1/groups/:group_id/memberships

{Needs a group ID}

Get the list of enrollments for the course.

GET /api/v1/courses/:course_id/enrollments

Then you could compare the enrollments list to the membership list.

Attached is a Windows Powershell script to do that.

It only gives student name and group name to a csv file.

[jareduval26]

If you would like to do this without the API, what I do is create an assignment that is not counted toward the final grade and set it as a group submission. Then, I go into speed grader and give acending grades (e.g., 1,2,3,4) to each group. That way, each student now has a "grade" that is actually their group membership. You can then download the grade roster to get a csv with their membership by deleting all the grades and other info you don't need. This also allows you to sort by group membership in the Canvas Gradebook by sorting by that assignment column. 

[acgottfr]

Thank you on behalf of those of use who do not know API nor have the time to dig into it.

[RobDitto]

@jareduval26, an easier way was recently added to Canvas. A teacher (or TA with the right permissions) can now download the Course Roster CSV from People > Groups as described here

•  How do I import groups in a group set? 
  (click +Import and then use Download Course Roster CSV link)

[richard_plunket]

I tried this, and the Course Roster CSV file has column headings, but no data. I tried filling in the columns from the class roster exported in "Grades". The group names were added, but no students were assigned to the groups. Is there some secret "Canvas handshake" I must perform to get this to work properly?