caccl-api/src/types/CanvasEnrollment.ts

A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.

interface CanvasEnrollment {
  // The ID of the enrollment.
  id: number,
  // The unique id of the course.
  course_id: number,
  // The SIS Course ID in which the enrollment is associated. Only displayed if
  // present. This field is only included if the user has permission to view SIS
  // information.
  sis_course_id: string,
  // The Course Integration ID in which the enrollment is associated. This field
  // is only included if the user has permission to view SIS information.
  course_integration_id: string,
  // The unique id of the user's section.
  course_section_id: number,
  // The Section Integration ID in which the enrollment is associated. This field
  // is only included if the user has permission to view SIS information.
  section_integration_id: string,
  // The SIS Account ID in which the enrollment is associated. Only displayed if
  // present. This field is only included if the user has permission to view SIS
  // information.
  sis_account_id: string,
  // The SIS Section ID in which the enrollment is associated. Only displayed if
  // present. This field is only included if the user has permission to view SIS
  // information.
  sis_section_id: string,
  // The SIS User ID in which the enrollment is associated. Only displayed if
  // present. This field is only included if the user has permission to view SIS
  // information.
  sis_user_id: string,
  // The state of the user's enrollment in the course.
  enrollment_state: string,
  // User can only access his or her own course section.
  limit_privileges_to_course_section: boolean,
  // The unique identifier for the SIS import. This field is only included if the
  // user has permission to manage SIS information.
  sis_import_id: number,
  // The unique id of the user's account.
  root_account_id: number,
  // The enrollment type. One of 'StudentEnrollment', 'TeacherEnrollment',
  // 'TaEnrollment', 'DesignerEnrollment', 'ObserverEnrollment'.
  type: (
    'StudentEnrollment'
    | 'TeacherEnrollment'
    | 'TaEnrollment'
    | 'DesignerEnrollment'
    | 'ObserverEnrollment'
  ),
  // The unique id of the user.
  user_id: number,
  // The unique id of the associated user. Will be null unless type is
  // ObserverEnrollment.
  associated_user_id: (number | null),
  // The enrollment role, for course-level permissions. This field will match
  // `type` if the enrollment role has not been customized.
  role: (
    'StudentEnrollment'
    | 'TeacherEnrollment'
    | 'TaEnrollment'
    | 'DesignerEnrollment'
    | 'ObserverEnrollment'
    | string
  ),
  // The id of the enrollment role.
  role_id: number,
  // The created time of the enrollment, in ISO8601 format.
  created_at: string,
  // The updated time of the enrollment, in ISO8601 format.
  updated_at: string,
  // The start time of the enrollment, in ISO8601 format.
  start_at: string,
  // The end time of the enrollment, in ISO8601 format.
  end_at: string,
  // The last activity time of the user for the enrollment, in ISO8601 format.
  last_activity_at: string,
  // The last attended date of the user for the enrollment in a course, in ISO8601
  // format.
  last_attended_at: string,
  // The total activity time of the user for the enrollment, in seconds.
  total_activity_time: number,
  // The URL to the Canvas web UI page for this course enrollment.
  html_url: string,
  // The URL to the Canvas web UI page containing the grades associated with this
  // enrollment.
  grades: {
    html_url: string,
    current_score: number,
    current_grade: string,
    final_score: number,
    final_grade: string,
  },
  // A description of the user.
  user: {
    id: number,
    name: string,
    sortable_name: string,
    short_name: string,
  },
  // The user's override grade for the course.
  override_grade: string,
  // The user's override score for the course.
  override_score: number,
  // The user's current grade in the class including muted/unposted assignments.
  // Only included if user has permissions to view this grade, typically teachers,
  // TAs, and admins.
  unposted_current_grade?: string | null,
  // The user's final grade for the class including muted/unposted assignments.
  // Only included if user has permissions to view this grade, typically teachers,
  // TAs, and admins..
  unposted_final_grade?: string | null,
  // The user's current score in the class including muted/unposted assignments.
  // Only included if user has permissions to view this score, typically teachers,
  // TAs, and admins..
  unposted_current_score?: number | null,
  // The user's final score for the class including muted/unposted assignments.
  // Only included if user has permissions to view this score, typically teachers,
  // TAs, and admins..
  unposted_final_score: number,
  // optional: Indicates whether the course the enrollment belongs to has grading
  // periods set up. (applies only to student enrollments, and only available in
  // course endpoints)
  has_grading_periods?: boolean | null,
  // optional: Indicates whether the course the enrollment belongs to has the
  // Display Totals for 'All Grading Periods' feature enabled. (applies only to
  // student enrollments, and only available in course endpoints)
  totals_for_all_grading_periods_option: boolean,
  // optional: The name of the currently active grading period, if one exists. If
  // the course the enrollment belongs to does not have grading periods, or if no
  // currently active grading period exists, the value will be null. (applies only
  // to student enrollments, and only available in course endpoints)
  current_grading_period_title?: string | null,
  // optional: The id of the currently active grading period, if one exists. If
  // the course the enrollment belongs to does not have grading periods, or if no
  // currently active grading period exists, the value will be null. (applies only
  // to student enrollments, and only available in course endpoints)
  current_grading_period_id?: number | null,
  // The user's override grade for the current grading period.
  current_period_override_grade?: string | null,
  // The user's override score for the current grading period.
  current_period_override_score?: number | null,
  // optional: The student's score in the course for the current grading period,
  // including muted/unposted assignments. Only included if user has permission to
  // view this score, typically teachers, TAs, and admins. If the course the
  // enrollment belongs to does not have grading periods, or if no currently
  // active grading period exists, the value will be null. (applies only to
  // student enrollments, and only available in course endpoints)
  current_period_unposted_current_score?: number | null,
  // optional: The student's score in the course for the current grading period,
  // including muted/unposted assignments and including ungraded assignments with
  // a score of 0. Only included if user has permission to view this score,
  // typically teachers, TAs, and admins. If the course the enrollment belongs to
  // does not have grading periods, or if no currently active grading period
  // exists, the value will be null. (applies only to student enrollments, and
  // only available in course endpoints)
  current_period_unposted_final_score?: number | null,
  // optional: The letter grade equivalent of
  // current_period_unposted_current_score, if available. Only included if user
  // has permission to view this grade, typically teachers, TAs, and admins. If
  // the course the enrollment belongs to does not have grading periods, or if no
  // currently active grading period exists, the value will be null. (applies only
  // to student enrollments, and only available in course endpoints)
  current_period_unposted_current_grade?: string | null,
  // optional: The letter grade equivalent of current_period_unposted_final_score,
  // if available. Only included if user has permission to view this grade,
  // typically teachers, TAs, and admins. If the course the enrollment belongs to
  // does not have grading periods, or if no currently active grading period
  // exists, the value will be null. (applies only to student enrollments, and
  // only available in course endpoints)
  current_period_unposted_final_grade?: string | null,
};

export default CanvasEnrollment;