Options
All
  • Public
  • Public/Protected
  • All
Menu

Module routes/student

Index

Functions

Functions

createStudentConfirmation

  • createStudentConfirmation(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Empty>

  • Attempts to create a student confirmation 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.Empty>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

createStudentSuggestion

  • createStudentSuggestion(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Empty>

  • Attempts to create a student suggestion 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.Empty>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

deleteStudent

  • deleteStudent(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Empty>

  • Attempts to delete a student from 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.Empty>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

filterStudents

  • filterStudents(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.StudentList>

  • Attempts to filter students in the system by name, role, alumni, student coach, status or email.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      The Express.js request to extract all required data from.

    Returns Promise<Responses.StudentList>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

getRouter

  • getRouter(): express.Router

  • Gets the router for all /student/ related endpoints.

    Returns express.Router

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

getStudent

  • getStudent(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Student>

  • Attempts to get all data for a certain student 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.Student>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

getStudentSuggestions

  • getStudentSuggestions(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.AllStudentEvaluationsResponse>

  • Attempts to list all suggestions for a certain student.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      The Express.js request to extract all required data from.

    Returns Promise<Responses.AllStudentEvaluationsResponse>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

Generated using TypeDoc