Options
All
  • Public
  • Public/Protected
  • All
Menu

Module routes/project

Index

Functions

Functions

assignCoach

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

  • Parameters

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

    Returns Promise<Responses.ProjectUser>

assignStudent

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

  • Parameters

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

    Returns Promise<Responses.ModProjectStudent>

createProject

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

  • Attempts to create a new project 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.Project>

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

createProjectRoleFor

  • createProjectRoleFor(project: number, role: string): Promise<{ count: number; project_role_id: number }>

  • Parameters

    • project: number
    • role: string

    Returns Promise<{ count: number; project_role_id: number }>

deleteProject

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

  • Attempts to delete a project 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.

filterProjects

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

  • Attempts to filter projects in the system by name, client, coaches or fully assigned.

    Parameters

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

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

    Returns Promise<Responses.ProjectListAndContracts>

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

getDraftedStudents

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

  • Attempts to get all drafted students in the system for a project.

    Parameters

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

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

    Returns Promise<Responses.ProjectDraftedStudents>

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

getFreeSpotsFor

  • getFreeSpotsFor(role: string, project: number): Promise<{ count: number; project_role_id: number; role_id: number }>

  • Parameters

    • role: string
    • project: number

    Returns Promise<{ count: number; project_role_id: number; role_id: number }>

getProject

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

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

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

getRouter

  • getRouter(): express.Router

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

    Returns express.Router

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

listProjects

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

  • Attempts to list all projects 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.ProjectListAndContracts>

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

modProject

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

  • Parameters

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

    Returns Promise<Responses.Project>

modProjectStudent

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

  • Parameters

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

    Returns Promise<Responses.ModProjectStudent>

unAssignCoach

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

  • Parameters

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

    Returns Promise<Responses.Empty>

unAssignStudent

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

  • Parameters

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

    Returns Promise<Responses.Empty>

Generated using TypeDoc