Skip to main content
Module

x/gesso/types/params.ts>ListPlannerNotesParams

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

Properties

optional
startdate: Date

Only return notes with todo dates since the start_date (inclusive). No default. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

optional
enddate: Date

Only return notes with todo dates before the end_date (inclusive). No default. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. If end_date and start_date are both specified and equivalent, then only notes with todo dates on that day are returned.

optional
context_codes: string[]

List of context codes of courses whose notes you want to see. If not specified, defaults to all contexts that the user belongs to. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42 Including a code matching the user's own context code (e.g. user_1) will include notes that are not associated with any particular course.