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

x/gesso/types/params.ts>CreateAnAssignmentOverrideParams

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

Properties

optional
assignment_override[student_ids]: number[]

The IDs of the override's target students. If present, the IDs must each identify a user with an active student enrollment in the course that is not already targetted by a different adhoc override.

optional
assignmentoverridetitle: string

The title of the adhoc assignment override. Required if student_ids is present, ignored otherwise (the title is set to the name of the targetted group or section instead).

optional
assignmentoverridegroupid: number

The ID of the override's target group. If present, the following conditions must be met for the override to be successful: the assignment MUST be a group assignment (a group_category_id is assigned to it) the ID must identify an active group in the group set the assignment is in the ID must not be targetted by a different override See Appendix: Group assignments for more info.

optional
assignmentoverridecoursesectionid: number

The ID of the override's target section. If present, must identify an active section of the assignment's course not already targetted by a different override.

optional
assignmentoverridedueat: Date

The day/time the overridden assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect due date. May be present but null to indicate the override removes any previous due date.

optional
assignmentoverrideunlockat: Date

The day/time the overridden assignment becomes unlocked. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect the unlock date. May be present but null to indicate the override removes any previous unlock date.

optional
assignmentoverridelockat: Date

The day/time the overridden assignment becomes locked. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not affect the lock date. May be present but null to indicate the override removes any previous lock date.