Notifications Hub » Development » REST API
Notifications Endpoints
This section describes endpoints for Notification management.
Table below provides a quick summary:
NotificationRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
GET | /api/count | Long count | ||||||
POST | /api/register | register | NotificationsRegistration | |||||
DELETE | /api/notification/ | DELETE | ||||||
GET | /api/notifications /api/notification | [] | Notification notifications | PageOptions | ||||
DELETE | /api/admin/notification/ | deleteAdmin | ||||||
POST | /api/event | submitEvent | Event | |||||
GET | /api/admin/count | Long countAdmin | ||||||
GET | /api/admin/notifications /api/admin/notification | [] | Notification notificationsAdmin | PageOptions |
Preferences Rest Endpoints
This section describes endpoints for NotificationTypes management.
Table below provides a quick summary:
NotificationTypeRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/preference/ | POST | PreferenceRestController.preference | NotifyPreference | |||||
| /api/preference | GET | Map | Preference PreferenceRestController.preferences |
Job Rest Endpoints
This section describes endpoints for Job management.
Table below provides a quick summary:
JobRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/admin/job | GET | Page | Job listJobs | JobFilter PageOptions | ||||
| /api/admin/job | DELETE | deleteJobs | [] | |||||
| /api/admin/job | POST | createJob | Job | |||||
| /api/admin/job/ | GET | Job getJob | ||||||
| /api/admin/job/ | DELETE | deleteJob | ||||||
| /api/admin/job/ | PUT | updateJob | Job |
NotificationType Rest Endpoints
This section describes endpoints for NotificationTypes management.
Table below provides a quick summary:
NotificationTypeRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description | |
|---|---|---|---|---|---|---|---|---|---|
GET | /api/admin/notificationtype | NotificationTypeFilter PageOptions | Page | OK | listNotificationTypes | ||||
DELETE | /api/admin/notificationtype | deleteMany | [] | ||||||
POST | /api/admin/notificationtype | createNotificationType | NotificationType | ||||||
PUT | /api/admin/notificationtype/ | updateNotificationType | NotificationType | ||||||
GET | /api/admin/notificationtype/ | NotificationType getNotificationType | |||||||
DELETE | /api/admin/notificationtype/ | deleteNotificationType |
Template REST Endpoints
This section describes endpoints for Template management.
Table below provides a quick summary:
TemplateRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
POST | /api[?/admin]/template//reload | reload | ||||||
GET | /api[?/admin]/template//subject | getSubject | ||||||
GET | /api[?/admin]/template/ | Template getTemplate | ||||||
POST | /api[?/admin]/template//send | send | Job | |||||
POST | /api[?/admin]/template/send | send | Job | |||||
DELETE | /api[?/admin]/template | deleteMany | [] | |||||
POST | /api[?/admin]/template/reload | reloadMany | [] | |||||
DELETE | /api[?/admin]/template/ | deleteTemplate | ||||||
POST | /api[?/admin]/template | createTemplate | Template | |||||
GET | /api[?/admin]/template | TemplateFilter PageOptions | Page | OK | listTemplates | |||
GET | /api[?/admin]/template/.html | getTemplateHtml | ||||||
PUT | /api[?/admin]/template/ | updateTemplate | Template |
Other
| /api/follow | GET | [] | ValuePreference FollowsRestController.follows | | /api/follow/ | POST | FollowsRestController.follow | | NotifyPreference
Related Publications
Comments and Discussion