Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReportController

Defines server endpoints for generating excel reports of data in the applciation. Note that these are not under the `/api/ path

Hierarchy

  • ReportController

Index

Properties

Private reportService

reportService: ReportService

Private semesterService

semesterService: SemesterService

Methods

getCoursesReport

  • getCoursesReport(res: Response, startYear: number, endYear: number): Promise<void>
  • Provides an xlsx report with all of the course data from the main table. By default, it provides info on course instances in all semesters from the currentAcademicYear through to the last academic year in the database.

    todo

    Add query string parameters for startYear and endYear (future feature)

    Parameters

    • res: Response
    • startYear: number
    • endYear: number

    Returns Promise<void>

getFacultyReport

  • getFacultyReport(res: Response, startYear: number, endYear: number): Promise<void>
  • Provides an xlsx report with all of the faculty data from the main table. By default, it provides info on faculty in all semesters from the currentAcademicYear through to the last academic year in the database.

    Parameters

    • res: Response
    • startYear: number
    • endYear: number

    Returns Promise<void>

Generated using TypeDoc