Options
All
  • Public
  • Public/Protected
  • All
Menu

Module routes/osoc

Index

Functions

Functions

createOsocEdition

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

  • 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.OsocEdition>

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

deleteOsocEditionRequest

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

  • 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.

filterYear

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

  • Attempts to filter osoc editions in the system by year.

    Parameters

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

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

    Returns Promise<Responses.OsocEditionList>

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

getRouter

  • getRouter(): express.Router

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

    Returns express.Router

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

listOsocEditions

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

  • Attempts to list all osoc editions 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.OsocEditionList>

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

Generated using TypeDoc