Skip to main content
Module

x/gesso/types/params.ts>ListAssignmentGroupsParams

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

Properties

optional
include: string[]

Allowed values: assignments, discussion_topic, all_dates, assignment_visibility, overrides, submission, observed_users, can_edit, score_statistics

optional
assignment_ids: string[]

If “assignments” are included, optionally return only assignments having their ID in this array. This argument may also be passed as a comma separated string.

optional
exclude_assignment_submission_types: string[]

Allowed values: online_quiz, discussion_topic, wiki_page, external_tool

optional
overrideassignmentdates: boolean

Apply assignment overrides for each assignment, defaults to true.

optional
gradingperiodid: number

The id of the grading period in which assignment groups are being requested (Requires grading periods to exist.)

optional
scopeassignmentstostudent: boolean

If true, all assignments returned will apply to the current user in the specified grading period. If assignments apply to other students in the specified grading period, but not the current user, they will not be returned. (Requires the grading_period_id argument and grading periods to exist. In addition, the current user must be a student.)