Course Assignments in a Term

[jschaffer]

Hello All,

I am trying to figure out a way to run an API that will give me all assignments, what type of assignment it is, as well as what course, and module the assignment is in, for a given term.  The reasoning behind this is that I need to assign start/end dates to the assignments before I copy courses, and instead of going into each our our 300 Master Shells, I would like to run an API to get this information, and then Post a value to the start/ed/due dates.

So far I am thinking that some variation of GET /v1/courses/assignments would work to pull the information, but I want to see if there is a way to limit this to only a specific term.  I do not see this parameter in the API notes.  Any ideas?

Jason

[akkaufmann]

Hey Jason,

From my understanding of the API, there isn't a quick way to limit courses to a specific term. You have to get the list of courses you want to work with, and then manually determine which ones are for the term you are looking for. That is what I did for a few scripts I wrote.

Here is some quick psuedo code for what I understand you want to do:

term_id //The id of the term you want to work with

courses[] = GET /api/v1/accounts/:account_id/courses //Get all the courses for account you want to work with, replace :account_id with the id of the account

foreach courses as course //Iterate through each course

     if course->enrollment_term_id == term_id //Check if current courses has the desired term

        assignments[] = GET  /api/v1/courses/course->id/assignments //If course has desired term,  get assignments

         foreach assignments as assignment //Iterate through each assignment

               PUT /api/v1/courses/course->id/assignments/assignment->id ... //Update assignment with desired parameters

This is code is just quick and messy, but I hope it can get you started. I put the variables in bold text to make it a little easier to read.

If you have any questions, I will try to help out.

Alex

[jschaffer]

Exactly right.  I have an API to GET the course IDs, I will just need to update it with the IDs for the courses.  I was hoping there was a parameter built into the assignment API to help me skip the first step/mapping. 

[dgrobani]

Jason, look at List active courses in an account. By including the enrollment_term_id request parameter, you can get only the courses in an account for a particular term. Then you'd loop through those courses, getting the assignments for each.

[jschaffer]

I have this API done already.  It will give me the term ID and Course ID.  I was just looking for a way to have one API to pull the course assignments within a given term without having to compile and compare data.  That doesn't seem possible yet.