I am working on an LTI tool to assist faculty in the setup of their course. I am looking to see if it is possible to identify and/or change the Course Home Page through the APIs.
Basically I am looking for an API version of:
@joseph3 ,
Yes.
You can obtain the current view using the Get a single course endpoint of the Courses API. You want the default_view.
From the documentation at the top of the API documentation page where they list the structures, you see this description of default_view.
the type of page that users will see when they first visit the course - 'feed': Recent Activity Dashboard - 'wiki': Wiki Front Page - 'modules': Course Modules/Sections Page - 'assignments': Course Assignments List - 'syllabus': Course Syllabus Page other types may be added in the future
To change it, use the Update a course endpoint.
Here, you need to send the course[default_view] query parameter, which says that allowed values are feed, wiki, modules, syllabus, or assignments.
If you're wanting to use a wiki_page (content page) as the front page, then there are more steps involved.
If you're looking to determine the actual page that is the front page, then use the Show front page endpoint of the Pages API.
If there is no front page set, you get a 404 Not Found error message that says:
"message": "No front page has been set"
If there is a front page set, then you get a Page response, which looks something like this:
Requesting the front_page doesn't give you the URL of the page to tell which one it is, it comes back as front-page. However, you can use the page_id with requests like /pages/2476060 to get that page. Otherwise, you can get a list of all of the pages and iterate through them looking for the front_page property to be true.
If you want to create a page and make it a the front page, then use the Update/create front page endpoint of the Pages API.
If you want to take an existing page and elevate it to the front page, then use the Update/create page endpoint of the Pages API and set the wiki_page[front_page]=true.
You should have a page set as the front page before you can tell Canvas to Update the Course to use a front page.
Hi @joseph3
Here is the API.
You just need to set "course[default_view]".
Best,
Mu
I'm building a tool for my institution that imports grades from another LTI tool into Canvas so instructors can automate late assignment policies not otherwise supported by Canvas. I'm trying to use the LTIv1.3 ID which is readily available on the LTI-side as a link to the student record on Canvas, but I can't find the ID…
How can one track Canvas Media use without having the reports available from Canvas Studio? Checking API endpoints and the Data 2 schema, there do not seem to be dedicated Canvas Media endpoints. Am I missing some? A method I've considered is using the body field of the wiki_pages table, as this contains the html code of…
Hello, I'm trying to utilize an API call to pull completed certificates and was hoping to download and store the certs as a backup. I can successfully run the API call but it will not allow me to view the certificate unless I access the URL while signed into an account where it's "my" cert. Is there a permissions setting…
UI for weekly progression idea that rest in the Schedule tab of the **K-12 UI** of Canvas it's incomplete and I really would not take it and push it into instance but I am going to post it here because in the past people like @James && @robotcars || @Steve_25 have had terrific input in the past... maybe w/their eyes and…
I have a new React + Flask webapp. It has its own login for users to start using the app. I have added this as an external tool in Canvas. What I want initially is to see of canvas users can start using the webapp without having to login if they click on the external tool link in a canvas course. I have 2 methods…
