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

x/gesso/types/params.ts>ListPlannerItemsParams

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

Properties

optional
startdate: Date

Only return items starting from the given date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

optional
enddate: Date

Only return items up to the given date. The value should be formatted as: yyyy- mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

optional
context_codes: string[]

List of context codes of courses and/or groups whose items you want to see. If not specified, defaults to all contexts associated to the current user. Note that concluded courses will be ignored unless specified in the includes[] parameter. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42, group_123

optional
observeduserid: string

Return planner items for the given observed user. Must be accompanied by context_codes[]. The user making the request must be observing the observed user in all the courses specified by context_codes[].

optional
filter: string

Allowed values: new_activity