import { type ListEnrollmentsParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";
Properties
A list of enrollment types to return. Accepted values are 'StudentEnrollment',
'TeacherEnrollment', 'TaEnrollment', 'DesignerEnrollment', and
'ObserverEnrollment.' If omitted, all enrollment types are returned. This
argument is ignored if role is given.
A list of enrollment roles to return. Accepted values include course-level roles
created by the Add Role API as well as the base enrollment types accepted by the
type argument above.
Allowed values: active, invited, creation_pending, deleted, rejected, completed, inactive, current_and_invited, current_and_future, current_and_concluded
Filter by user_id (only valid for course or section enrollment queries). If set to the current user's id, this is a way to determine if the user has any enrollments in the course or section, independent of whether the user has permission to view other people on the roster.
Return grades for the given grading_period. If this parameter is not specified, the returned grades will be for the whole course.
Returns only enrollments for the specified enrollment term. This parameter only applies to the user enrollments path. May pass the ID from the enrollment terms api or the SIS id prepended with 'sis_term_id:'.
Returns only enrollments for the specified SIS account ID(s). Does not look into sub_accounts. May pass in array or string.
Returns only section enrollments matching the specified SIS section ID(s). May pass in array or string.
If sis_user_id is present and created_for_sis_id is true, Returns only enrollments for the specified SIS ID(s). If a user has two sis_id's, one enrollment may be created using one of the two ids. This would limit the enrollments returned from the endpoint to enrollments that were created from a sis_import with that sis_user_id