Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/gesso/types/params.ts>UpdateCourseParams

A TypeScript API client for Canvas LMS
Latest
interface UpdateCourseParams
import { type UpdateCourseParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
courseaccountid: number

The unique ID of the account to move the course to.

optional
coursename: string

The name of the course. If omitted, the course will be named “Unnamed Course.”

optional
coursecoursecode: string

The course code for the course.

optional
coursestartat: Date

Course start date in ISO8601 format, e.g. 2011-01-01T01:00Z This value is ignored unless 'restrict_enrollments_to_course_dates' is set to true, or the course is already published.

optional
courseendat: Date

Course end date in ISO8601 format. e.g. 2011-01-01T01:00Z This value is ignored unless 'restrict_enrollments_to_course_dates' is set to true.

optional
courselicense: string

The name of the licensing. Should be one of the following abbreviations (a descriptive name is included in parenthesis for reference): 'private' (Private Copyrighted) 'cc_by_nc_nd' (CC Attribution Non-Commercial No Derivatives) 'cc_by_nc_sa' (CC Attribution Non-Commercial Share Alike) 'cc_by_nc' (CC Attribution Non-Commercial) 'cc_by_nd' (CC Attribution No Derivatives) 'cc_by_sa' (CC Attribution Share Alike) 'cc_by' (CC Attribution) 'public_domain' (Public Domain).

optional
courseispublic: boolean

Set to true if course is public to both authenticated and unauthenticated users.

optional
courseispublictoauthusers: boolean

Set to true if course is public only to authenticated users.

optional
coursepublicsyllabus: boolean

Set to true to make the course syllabus public.

optional
coursepublicsyllabustoauth: boolean

Set to true to make the course syllabus to public for authenticated users.

optional
coursepublicdescription: string

A publicly visible description of the course.

optional
courseallowstudentwikiedits: boolean

If true, students will be able to modify the course wiki.

optional
courseallowwikicomments: boolean

If true, course members will be able to comment on wiki pages.

optional
courseallowstudentforumattachments: boolean

If true, students can attach files to forum posts.

optional
courseopenenrollment: boolean

Set to true if the course is open enrollment.

optional
courseselfenrollment: boolean

Set to true if the course is self enrollment.

optional
courserestrictenrollmentstocoursedates: boolean

Set to true to restrict user enrollments to the start and end dates of the course. Setting this value to false will remove the course end date (if it exists), as well as the course start date (if the course is unpublished).

optional
coursetermid: number

The unique ID of the term to create to course in.

optional
coursesiscourseid: string

The unique SIS identifier.

optional
courseintegrationid: string

The unique Integration identifier.

optional
coursehidefinalgrades: boolean

If this option is set to true, the totals in student grades summary will be hidden.

optional
coursetimezone: string

The time zone for the course. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

optional
courseapplyassignmentgroupweights: boolean

Set to true to weight final grade based on assignment groups percentages.

optional
coursestoragequotamb: number

Set the storage quota for the course, in megabytes. The caller must have the “Manage storage quotas” account permission.

optional
offer: boolean

If this option is set to true, the course will be available to students immediately.

optional
courseevent: string

Allowed values: claim, offer, conclude, delete, undelete

optional
coursedefaultview: string

Allowed values: feed, wiki, modules, syllabus, assignments

optional
coursesyllabusbody: string

The syllabus body for the course

optional
coursesyllabuscoursesummary: boolean

Optional. Indicates whether the Course Summary (consisting of the course's assignments and calendar events) is displayed on the syllabus page. Defaults to true.

optional
coursegradingstandardid: number

The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course.

optional
coursegradepassbacksetting: string

Optional. The grade_passback_setting for the course. Only 'nightly_sync' and '' are allowed

optional
coursecourseformat: string

Optional. Specifies the format of the course. (Should be either 'on_campus' or 'online')

optional
courseimageid: number

This is a file ID corresponding to an image file in the course that will be used as the course image. This will clear the course's image_url setting if set. If you attempt to provide image_url and image_id in a request it will fail.

optional
courseimageurl: string

This is a URL to an image to be used as the course image. This will clear the course's image_id setting if set. If you attempt to provide image_url and image_id in a request it will fail.

optional
courseremoveimage: boolean

If this option is set to true, the course image url and course image ID are both set to nil

optional
courseremovebannerimage: boolean

If this option is set to true, the course banner image url and course banner image ID are both set to nil

optional
courseblueprint: boolean

Sets the course as a blueprint course.

optional
courseblueprintrestrictions: BlueprintRestriction

Sets a default set to apply to blueprint course objects when restricted, unless use_blueprint_restrictions_by_object_type is enabled. See the Blueprint Restriction documentation

optional
courseuseblueprintrestrictionsbyobjecttype: boolean

When enabled, the blueprint_restrictions parameter will be ignored in favor of the blueprint_restrictions_by_object_type parameter

optional
courseblueprintrestrictionsbyobjecttype: BlueprintRestriction[]

Allows setting multiple Blueprint Restriction to apply to blueprint course objects of the matching type when restricted. The possible object types are “assignment”, “attachment”, “discussion_topic”, “quiz” and “wiki_page”. Example usage: course[blueprint_restrictions_by_object_type][assignment][content]=1

optional
coursehomeroomcourse: boolean

Sets the course as a homeroom course. The setting takes effect only when the course is associated with a Canvas for Elementary-enabled account.

optional
coursesyncenrollmentsfromhomeroom: string

Syncs enrollments from the homeroom that is set in homeroom_course_id. The setting only takes effect when the course is associated with a Canvas for Elementary-enabled account and sync_enrollments_from_homeroom is enabled.

optional
coursehomeroomcourseid: string

Sets the Homeroom Course id to be used with sync_enrollments_from_homeroom. The setting only takes effect when the course is associated with a Canvas for Elementary-enabled account and sync_enrollments_from_homeroom is enabled.

optional
coursetemplate: boolean

Enable or disable the course as a template that can be selected by an account

optional
coursecoursecolor: string

Sets a color in hex code format to be associated with the course. The setting takes effect only when the course is associated with a Canvas for Elementary- enabled account.

optional
coursefriendlyname: string

Set a friendly name for the course. If this is provided and the course is associated with a Canvas for Elementary account, it will be shown instead of the course name. This setting takes priority over course nicknames defined by individual users.

optional
courseenablecoursepaces: boolean

Enable or disable Course Pacing for the course. This setting only has an effect when the Course Pacing feature flag is enabled for the sub-account. Otherwise, Course Pacing are always disabled. Note: Course Pacing is in active development.

optional
courseconditionalrelease: boolean

Enable or disable individual learning paths for students based on assessment

optional
overridesisstickiness: boolean

Default is true. If false, any fields containing “sticky” changes will not be updated. See SIS CSV Format documentation for information on which fields can have SIS stickiness