SudoSOS Back-end API / banners
banners ​
banners are used to manage promotional material within SudoSOS, commonly displayed on the point of sale. They can be configured with a duration, activation status, and start/end dates to control their visibility.
Usage ​
- Banners can be created, updated, or deleted by admins.
- Active banners can be retrieved without authentication.
For API interactions, refer to the Swagger Documentation.
Classes ​
| Class | Description |
|---|---|
| Banner | TypeORM entity for the banners table. |
| BannerController | Controller for managing all routes related to the banner entity. |
| BannerImage | TypeORM entity for banner images. Note that the image itself is stored in the file system, but the table is used to store the location of the image. |
| BannerService | Service class for the banner entity, |
Interfaces ​
| Interface | Description |
|---|---|
| BannerFilterParameters | Filter parameters for the banner entity. |
| BannerRequest | API Request for creating a banner entity. |
| BannerResponse | API Response for the banner entity. |
| PaginatedBannerResponse | Paginated API Response for the banner entity. |