How to GET Canvas_Course_ID using API, knowing Course_SYS_ID

[AlonaLanski]

Hi, I have trouble to get Canvas_Course_ID with API. I know I can get the Course data by using API /api/v1/courses/:id with ":id" been the Canvass_Course_Id  (below in bold). But I would like to use SYS_ID to actually get Canvas_Course_ID.

Is it even possible?

Thank you. Alona

GET https://sandiego.instructure.com/api/v1/courses/14019

[chriscas · Accepted solution]

Hi @AlonaLanski,

if you take a look at the sis_ids api documentation, you'll see you should be able to visit /api/v1/courses/sis_course_id:ABCDEFG (replace ABCDEFG with your own sis_id).  The API response will include the canvas_id of the course you specified.

Hope this helps!

-Chris

[chriscas · Accepted solution]

Hi @AlonaLanski,

if you take a look at the sis_ids api documentation, you'll see you should be able to visit /api/v1/courses/sis_course_id:ABCDEFG (replace ABCDEFG with your own sis_id).  The API response will include the canvas_id of the course you specified.

Hope this helps!

-Chris

[AlonaLanski]

Thank you Chris for your quick post. Yes, I did try that. And got nothing, I use the SYS_ID of the Canvas_Course_ID of 14019 , but got

 "message": "The specified resource does not exist."

Please see below (I tried it in quotes and in double quotes).

https://sandiego.instructure.com/api/v1/courses/202409-ESH-502-01

And I even tried to pass sys_course_id as parameter (two links down below). Both gave me Error Code of 200 OK, but Body showed nothing:

[]

 I probably doing something wrong, but cannot figure out what. Alona

https://sandiego.instructure.com/api/v1/courses/?course[sis_course_id]=202409-ESH-502-01

https://sandiego.instructure.com/api/v1/courses/?sis_course_id=202409-ESH-502-01

[chriscas · Accepted solution]

Hi @AlonaLanski,

With your example, the correct url would be: https://sandiego.instructure.com/api/v1/courses/sis_course_id:202409-ESH-502-01.  Let us know if that works.

-Chris

[AlonaLanski]

It did! Thank you so much. I had a really bad day and your help is the only a good thing happened to me today. Very much appreciated! I knew I did something wrong. I'm new in everything API. Thank you again.