SudoSOS Back-end API / events / EventController
Class: EventController ​
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
Extends ​
Constructors ​
Constructor ​
new EventController(options): EventController;Create a new user controller instance.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
options | BaseControllerOptions | The options passed to the base controller. |
Returns ​
EventController
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 ​
assignEventShift() ​
assignEventShift(req, res): Promise<void>;PUT /events/{eventId}/shift/{shiftId}/user/{userId}/assign
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Created event
Tags ​
events - Operations of the event controller
Operation Id ​
assignEventShift
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
createEvent() ​
createEvent(req, res): Promise<void>;POST /events
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Created event
Tags ​
events - Operations of the event controller
Operation Id ​
createEvent
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
deleteEvent() ​
deleteEvent(req, res): Promise<void>;DELETE /events/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
204 - Success
Tags ​
events - Operations of the event controller
Operation Id ​
deleteEvent
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
getAllEvents() ​
getAllEvents(req, res): Promise<void>;GET /events
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All existing events
Tags ​
events - Operations of the event controller
Operation Id ​
getAllEvents
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
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 ​
getSingleEvent() ​
getSingleEvent(req, res): Promise<void>;GET /events/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All existing events
Tags ​
events - Operations of the event controller
Operation Id ​
getSingleEvent
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
syncEventShiftAnswers() ​
syncEventShiftAnswers(req, res): Promise<void>;Synchronize an event, so that EventShiftAnswers are created/deleted for users that are (no longer) part of a shift
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - All existing events
Route ​
GET /events/{id}/sync
Tags ​
events - Operations of the event controller
Operation Id ​
syncEventShiftAnswers
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
updateEvent() ​
updateEvent(req, res): Promise<void>;PATCH /events/
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Created event
Tags ​
events - Operations of the event controller
Operation Id ​
updateEvent
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
updateShiftAvailability() ​
updateShiftAvailability(req, res): Promise<void>;POST /events/{eventId}/shift/{shiftId}/user/{userId}/availability
Parameters ​
| Parameter | Type |
|---|---|
req | RequestWithToken |
res | Response |
Returns ​
Promise<void>
200 - Created event
Tags ​
events - Operations of the event controller
Operation Id ​
updateEventShiftAvailability
Security ​
JWT
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.