Module routes/role

Index

Functions

Functions

createStudentRole

createStudentRole(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.PartialStudent>

- Defined in routes/role.ts:35
Attempts to create a new role in the system.

Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  
  The Express.js request to extract all required data from.
Returns Promise<Responses.PartialStudent>
See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

getRouter

getRouter(): express.Router

- Defined in routes/role.ts:59
Gets the router for all /role/ related endpoints.

Returns express.Router
An Express.js {@link express.Router} routing all /role/ endpoints.

listStudentRoles

listStudentRoles(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.StudentRoles>

- Defined in routes/role.ts:14
Attempts to list all roles in the system.

Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  
  The Express.js request to extract all required data from.
Returns Promise<Responses.StudentRoles>
See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

Generated using TypeDoc