SudoSOS Back-end API / internal/controllers / InactiveAdministrativeCostController
Class: InactiveAdministrativeCostController ​
The BaseController class is responsible for:
- Storing route definitions.
- Generating router objects based on the policy.
Extends ​
Constructors ​
Constructor ​
new InactiveAdministrativeCostController(options): InactiveAdministrativeCostController;Creates a new InactiveAdministrativeCost controller instance
Parameters ​
| Parameter | Type | Description |
|---|---|---|
options | BaseControllerOptions | The options passed to the base controller. |
Returns ​
InactiveAdministrativeCostController
Overrides ​
Properties ​
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
roleManager | protected | RoleManager | A reference to the role manager passed in the base controller options. | BaseController.roleManager |
specification | public | SwaggerSpecification | A reference to the swagger specification passed in the base controller options. | BaseController.specification |
Methods ​
checkInactiveUsers() ​
checkInactiveUsers(req, res): Promise<void>;GET /inactive-administrative-costs/eligible-users
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - List of eligible users
Operation Id ​
getInactiveAdministrativeCostsEligibleUsers
Tags ​
inactiveAdministrativeCosts - Operations of the inactive administrative cost controller
Security ​
JWT
createInactiveAdministrativeCost() ​
createInactiveAdministrativeCost(req, res): Promise<void>;POST /inactive-administrative-costs
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The created inactive administrative cost entity
Operation Id ​
createInactiveAdministrativeCosts
Tags ​
inactiveAdministrativeCosts - Operations of the inactive administrative cost controller
Security ​
JWT
deleteInactiveAdministrativeCost() ​
deleteInactiveAdministrativeCost(req, res): Promise<void>;DELETE /inactive-administrative-costs/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
404 - Invoice not found
Operation Id ​
deleteInactiveAdministrativeCost
Tags ​
inactiveAdministrativeCosts - Operations of the inactive administrative cost controller
Security ​
JWT
getAllInactiveAdministrativeCosts() ​
getAllInactiveAdministrativeCosts(req, res): Promise<void>;GET /inactive-administrative-costs
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All existing inactive administrative costs
Operation Id ​
getAllInactiveAdministrativeCosts
Tags ​
inactiveAdministrativeCosts - Operations of the invoices controller
Security ​
JWT
getInactiveAdministrativeCostReport() ​
getInactiveAdministrativeCostReport(req, res): Promise<void>;GET /inactive-administrative-costs/report
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The requested report
Operation Id ​
getInactiveAdministrativeCostReport
Tags ​
inactiveAdministrativeCosts - Operations of the inactive administrative cost controller
Security ​
JWT
getInactiveAdministrativeCostReportPdf() ​
getInactiveAdministrativeCostReportPdf(req, res): Promise<void>;GET /inactive-administrative-costs/report/pdf
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - The requested report - application/pdf
Operation Id ​
getInactiveAdministrativeCostReportPdf
Tags ​
inactiveAdministrativeCosts - Operations of the inactive administrative cost controller
Security ​
JWT
getPolicy() ​
getPolicy(): Policy;Gets the policy defined by child classes. This policy includes all routes that the controller accepts, the authorization middleware, and the final handler function for every route.
Returns ​
The policy of this controller.
Overrides ​
getRouter() ​
getRouter(): Router;Returns ​
Router
the router used by this controller.
Inherited from ​
getSingleInactiveAdministrativeCost() ​
getSingleInactiveAdministrativeCost(req, res): Promise<void>;GET /inactive-administrative-costs/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All existing inactive administrative cost
Operation Id ​
getInactiveAdministrativeCosts
Tags ​
inactiveAdministrativeCosts - Operations of the invoices controller
Security ​
JWT
handoutInactiveAdministrativeCost() ​
handoutInactiveAdministrativeCost(req, res): Promise<void>;POST /inactive-administrative-costs/handout
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success
Operation Id ​
handoutInactiveAdministrativeCostsUsers
Tags ​
inactiveAdministrativeCosts - Operations of the inactive administrative cost controller
Security ​
JWT
notifyInactiveUsers() ​
notifyInactiveUsers(req, res): Promise<void>;POST /inactive-administrative-costs/notify
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success
Operation Id ​
notifyInactiveAdministrativeCostsUsers
Tags ​
inactiveAdministrativeCosts - Operations of the inactive administrative cost controller
Security ​
JWT