Community

ulrik_sandgren · ‎02-02-2022

I realized after posting this that the check should be done on a section instead of a course Something like: GET /api/v1/sections/:id/concluded or that returns true/false

ulrik_sandgren · ‎02-02-2022

It is a bit complicated to check if a course is open for enrollment, the business rules involves many parameters. It is course status, course dates and term dates and combinations of those if null values exists. It would be nice to use Canvas Rest API for evaluate this instead of trying to write your own check. Something like: GET /api/v1/courses/:course_id/concluded that returns true/false

ulrik_sandgren · ‎09-30-2020

Yes but in my case I dont have the course, the SIS integration works directly on sections and not courses. the reason for this is that section can be cross listed without noticing the SIS integration. I need to get the section first by sis_section_id and then from the section get the course and then read the course state.

ulrik_sandgren · ‎09-30-2020

I'm writing an integration for our SIS system and I can't find a way to handle deleted courses properly. The integration enrols students by getting the sections by their section_sis_id and then gets the course and if the status of the course is not completed makes the enrollment. But if the course has been deleted the integration fails to get the section. I would like to have the section and then the course and then check if course state is deleted, for the reason to handle this as OK instead of an failure.

ulrik_sandgren · ‎09-18-2020

In our test instance of Canvas I tested the following scenario. I created an admin role with the only purpose to create users, the permissions for the role was: Users - manage login details (which enables merge users) SIS Data - read Users - add / remove students in courses Users - add / remove teachers, course designers, or TAs in courses Users - view list Users - view login IDs Users - view primary email address I then set the new role on a test user and logged in as this user for testing and it worked as I wanted, I could create users and enrol them to courses, I could change passwords for ordinary users but not for users with a admin role. But then I tested to merge users and found out that I could create a new user, merge the new user with a admin user. I could then log in as the new user and get the full permissions of the merged admin user. I would consider this as a security bug, the merge should not be permitted.

ulrik_sandgren · ‎05-19-2020

We have a new integration for our Canvas, the integration uses the Canvas rest API for creating courses and enrolments. Courses are created well spread during time but when it comes to enrolment we expect a huge amount at the same time. All requests are synchronized so there will not be any parallel calls to Canvas. A typical enrolment for our integration includes these rest API calls(finding user, finding course, finding section, enrol to section): GetAsync uri:/api/v1/accounts/self/users?search_term=xxyy 2020-05-18 07:10:20Z 6052 33 GetAsync uri:/api/v1/courses/593 2020-05-18 07:10:21Z 6052 33 GetAsync uri:/api/v1/courses/593/sections?per_page=500 2020-05-18 07:10:21Z 6052 33 PostAsync uri:/api/v1/courses/593/enrollments, body:{ "enrollment": { "user_id": "29049", "role_id": 3, "enrollment_state": "active", "course_section_id": 542, "notify": false }} 2020-05-18 07:10:21Z 6052 33 Normally an enrolment takes 2-4 seconds. Should we expect some kind of problems if trying to make ten thousands enrolments in a sequence? We have heard some rumors about the rest API is not 100% reliable and that it would be better to use the csv API feature. Are there any experience on this issue?

ulrik_sandgren · ‎05-02-2020

Thanks Adam But as far I can see you need the section id for the enrolment and how does the integration get the section id, I can not find a API method to search for sections on sis id? All I can find is to go thru the course id (GET /api/v1/courses/:course_id/sections).

ulrik_sandgren · ‎05-02-2020

How should an integration work to find a cross listed section when making a enrolment? Lets say you have an integration that handles enrolment and that the course sis id is set by the integration at creation. Later on a teacher cross lists the section Then a student is going to be enroled by the integration (using sis id for course and student id), the integration starts doing this: 1. Finds the course id by searching with course sis id 2. Finds all section on the course id 3. Enrol the student on section id But because the section has been cross listed step 2 fails to return the section. And I can not find any API methods to search for sections without having a course id. How should the integration work to be able to continue enrolling on sections after section been cross listed?

ulrik_sandgren · ‎04-25-2020

I suspected that Canvas has some kind of cache that needs to be updated, thats the only answer that makes sense on this. I will investigate if we could make some changes to use use the user id instead of search the user, I guess that will solve this issue. But I would like to see an answer from Instructure on this because I have not found anything on this in the documentation.

ulrik_sandgren · ‎04-25-2020

Hi This is what I found when I checked our logs in our integration: PostAsync uri:/api/v1/accounts/self/users, body:{ "user": { "name": "xx yy", "short_name": "xx yy", "sortable_name": "yy, xx", "terms_of_use": true }, "pseudonym": { "unique_id": "xxxyyy@umu.se", "sis_user_id": "zz" }, "communication_channel": { "type": "email", "address": "xx.yy@umu.se" }} 2020-04-24 10:08:18Z 17772 17 Leave CanvasService:AddNewUser() result: Id: xxxyyy@umu.se, UserId: 914 2020-04-24 10:08:19Z 17772 17 Enter CanvasService:EnrolUser() EnrolmentDto: TargetSystem: CANVAS, Site: {Person: {Id: xxxyyy 2020-04-24 10:08:19Z 17772 17 GetAsync uri:/api/v1/accounts/self/users?search_term=xxxyyy@umu.se 2020-04-24 10:08:19Z 17772 17 GetAsync uri:/api/v1/accounts/self/users?search_term=xxxyyy@umu.se 2020-04-24 10:08:20Z 17772 17 GetAsync uri:/api/v1/accounts/self/users?search_term=xxxyyy@umu.se 2020-04-24 10:08:23Z 17772 17 As you can see the user was created and a user id was returned, then a short time after the user is going to be enroled but Canvas can not find the user and the program makes 2 retries with a delay and finally finds the user. Can anyone explain what is happening here, why does not Canvas find the user in the first attempt?

ulrik_sandgren · ‎12-04-2019

Hi Aasmund This is the steps I did: Login as admin (a dedicated system admin account is probably best for this) and choose your main account Click Developer Keys Select tab Inherited, select show all and make sure Kaltura is set to Off Select tab Account (still in developer keys) Create a new developer key and provide Key Name, owner email and "Redirect URI (Legacy)", the last must be to your KAF and should include https:// For your new developer key you will find an ID in the details column (ex 1234000000000000001) copy that value Open KMC web and select Canvas in the left menu far below, paste the value to the field appId at the bottom of the page Back to Canvas and for the same developer key click show key and copy that value and paste i it in KMC in the field appKey Dont forget to enable the created developer key Hope this will help you /Ulrik

ulrik_sandgren · ‎12-04-2019

I found out the answer, I could not use the inherited developer key, that was bound for using KAF hosted at kaltura.com. After creating a new developer key everything seems working.

ulrik_sandgren · ‎12-03-2019

I'm integrating the Kaltura media services but is now stuck with the "redirect_uri does not match client settings" failure when trying to start the Kaltura tool. As far I can see I have configured KMC correctly and the LTI config looks OK, I have also enabled the inherited developer key for Kaltura. But there is one thing I don't understand, normally when you create a developer key you set a redirect uri but for a inherited key I can't find any redirect uri values. The fault indicates that this might cause the problem but I dont understand how this is supposed to work? Thanks

ulrik_sandgren · ‎11-21-2019

Is it possible to hide/show a LTI tool at "account level" based on which role a user have? We are planning on have a custom role "employee" which should enable the user to run a LTI tool and we would like to hide the tool for students.

ulrik_sandgren · ‎11-08-2019

Thanks Brian, good idea but in our case it is possible to create courses both from the API and within Canvas. The described problem occurs for courses created with the API, but the URL is today saved in another part of the system where there are no write backs of the course creation data. But if there are no alternatives we may end up with a re-design of this. Thanks again, regards /Ulrik

ulrik_sandgren · ‎11-08-2019

We are in the planning phase of our Canvas startup and I am looking into the integration parts. In our current course creation application used to create courses for other LMS than Canvas (Moodle and Sakai) we are setting an URL directly to courses before the courses has been created, we are using an unique ID. For Canvas I can not find a way to do this, the only direct URL to a course is http://<my canvas>/courses/<course id> Where <course id> is generated at course creation. Is there another way to do this or is is not possible to know a URL before the course has been created?

Post Details	Date Published	Views	Likes
Canvas Rest API for checking course conclude status It is a bit complicated to check if a course is open for enrollment, the business rules involves many parameters. It is course status, course dates and term dates and combinations of those if null va...	02-02-2022	257	0
Find section for deleted course I'm writing an integration for our SIS system and I can't find a way to handle deleted courses properly. The integration enrols students by getting the sections by their section_sis_id and then gets...	09-30-2020	636	0
Security bug in merge user? In our test instance of Canvas I tested the following scenario. I created an admin role with the only purpose to create users, the permissions for the role was: Users - manage login details (which...	09-18-2020	354	0
Performance of Canvas rest API? We have a new integration for our Canvas, the integration uses the Canvas rest API for creating courses and enrolments. Courses are created well spread during time but when it comes to enrolment we e...	05-19-2020	649	0
Finding cross listed section from course with rest API How should an integration work to find a cross listed section when making a enrolment? Lets say you have an integration that handles enrolment and that the course sis id is set by the integration ...	05-02-2020	1471	1
Created user with rest API does not exist immediately after creation Hi This is what I found when I checked our logs in our integration: PostAsync uri:/api/v1/accounts/self/users, body:{ "user": { "name": "xx yy", "short_name": "xx yy", "sortable_name": "yy, xx", "t...	04-25-2020	879	1
Integrating Kaltura LTI tool fails with "redirect_uri does not match client settings" I'm integrating the Kaltura media services but is now stuck with the "redirect_uri does not match client settings" failure when trying to start the Kaltura tool. As far I can see I have configured K...	12-03-2019	1050	2
Hide/show LTI tool depending on role? Is it possible to hide/show a LTI tool at "account level" based on which role a user have? We are planning on have a custom role "employee" which should enable the user to run a LTI tool and we woul...	11-21-2019	756	0
Knowing the URL to course before creation We are in the planning phase of our Canvas startup and I am looking into the integration parts. In our current course creation application used to create courses for other LMS than Canvas (Moodle and...	11-08-2019	803	1

Posts	19
Solutions	0
Likes given	14
Likes received	8
Member Since	‎11-08-2019

Community

Have a Canvas Question?

Have a Mastery Question?

Have an Elevate Question?

Have an Impact Question?

Re: Canvas Rest API for checking course conclude s...

Canvas Rest API for checking course conclude statu...

Re: Find section for deleted course

Find section for deleted course

Security bug in merge user?

Performance of Canvas rest API?

Re: Finding cross listed section from course with ...

Finding cross listed section from course with rest...

Re: Created user with rest API does not exist imme...

Created user with rest API does not exist immediat...

Re: Integrating Kaltura LTI tool fails with "redir...

Re: Integrating Kaltura LTI tool fails with "redir...

Integrating Kaltura LTI tool fails with "redirect_...

Hide/show LTI tool depending on role?

Re: Knowing the URL to course before creation

Knowing the URL to course before creation

Canvas Developers Group