Module routes/Module

Index

Functions

Functions

addCourse

addCourse(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:213
async
Adds a Course to a Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/:moduleId/addCourse

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

addSubmodule

addSubmodule(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:275
async
Adds a Submodule to a Module with the data given in the HTTP-Request
Corresponding API-Call: Post /module/:moduleId/addSubmodule

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

addTeacher

addTeacher(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:150
async
Adds a Teacher to a Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/:moduleId/addTeacher

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

changeDescription

changeDescription(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:255
async
Changes the description of a Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/:moduleId/changeDescription

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

changeName

changeName(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:341
async
Changes the name of a Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/:moduleId/changeName

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

deleteCourse

deleteCourse(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:236
async
Deletes a Course from a Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/:moduleId/deleteCourse

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

deleteModule

deleteModule(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:132
async
Deletes a Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/:moduleId/deleteModule

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

deleteSubmodule

deleteSubmodule(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:310
async
Deletes a Submodule from a Module with the data given in the HTTP-Request
Corresponding API-Call: POST module/:moduleId/deleteSubmodule

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

deleteTeacher

deleteTeacher(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:182
async
Deletes a Teacher from a Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/:moduleId/deleteTeacher

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

getAllModules

getAllModules(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:433
async
Returns all modules that exist

Parameters
- req: Request
- res: Response
Returns Promise<void>

getModules

getModules(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:397
async
Returns modules for a student or a teacher Corresponding API-Call: GET /module/:moduleId/getStudents

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

getStudents

getStudents(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:379
async
Returns all students of a module
Corresponding API-Call: GET /module/:moduleId/getStudents

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

registerModule

registerModule(req: Request, res: Response): void

- Defined in routes/Module.ts:115
Registers a new Module with the data given in the HTTP-Request
Corresponding API-Call: POST /module/register

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns void

selectModule

selectModule(req: Request, res: Response): Promise<void>

- Defined in routes/Module.ts:363
async
Returns the informations of a module
Corresponding API-Call: GET /module/:moduleId

Parameters
- req: Request
  
  Holds the data from the HTTP-Request
- res: Response
  
  Used to form the response
Returns Promise<void>

Generated using TypeDoc