Notification APIs
Summary
| API | Purpose | Usage in Izenda Front-end |
|---|---|---|
| GET notifications | Returns the current user's notifications. | Pending ENG confirmation |
| POST notifications | Creates a notification. | Pending ENG confirmation |
| POST notifications/read/(userId) | Marks notifications as read for the specified user, or for the current user if userId is omitted. | Pending ENG confirmation |
| POST notifications/clear/(userId) | Clears notifications for the specified user, or for the current user if userId is omitted. | Pending ENG confirmation |
GET notifications
Returns the current user's notifications.
Request
No payload
Response
An OperationResult object with data field containing an array of UserNotification objects
POST notifications
Creates a notification.
Request
Payload: a UserNotification object
Response
An OperationResult object with success field true
POST notifications/read/(userId)
Marks notifications as read for the specified user, or for the current user if userId is omitted.
Request
Path param: userId (optional guid)
Response
An OperationResult object with success field true
POST notifications/clear/(userId)
Clears notifications for the specified user, or for the current user if userId is omitted.
Request
Path param: userId (optional guid)
Response
An OperationResult object with success field true