Notification Resource¶
Mark Read Notifications¶
HTTP Request
POST /api/notifications/{id}/read
📋 Description: Marks a specific notification as read, updating its status in the system to enhance user engagement and streamline notification management. This operation ensures that users can efficiently track their interactions with notifications.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Notifications¶
HTTP Request
GET /api/notifications/{userName}
📋 Description: Fetches notifications for the specified user, enabling timely access to important updates and alerts relevant to their account.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userName |
path |
string |
true |
Name of the user |
page |
query |
integer(int32) |
false |
Page number for pagination |
size |
query |
integer(int32) |
false |
Number of items per page |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "title": "string",
26 "forUserId": "string",
27 "byUserId": "string",
28 "message": "string",
29 "redirectTo": "string",
30 "displayId": "string",
31 "createdTime": "string",
32 "pcUserNotificationId": "string",
33 "pcNotificationId": "string",
34 "read": true
35 }
36 ],
37 "number": 0,
38 "sort": {
39 "unsorted": true,
40 "sorted": true,
41 "empty": true
42 },
43 "empty": true
44}
Get Mobile Notifications¶
HTTP Request
GET /api/notifications/{userName}/for-mobile
📋 Description: Fetches mobile notifications for the specified user, enabling timely access to important updates and alerts.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userName |
path |
string |
true |
Name of the user |
page |
query |
integer(int32) |
false |
Page number for pagination |
size |
query |
integer(int32) |
false |
Number of items per page |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "title": "string",
26 "forUserId": "string",
27 "byUserId": "string",
28 "message": "string",
29 "redirectTo": "string",
30 "displayId": "string",
31 "createdTime": "string",
32 "pcUserNotificationId": "string",
33 "pcNotificationId": "string",
34 "read": true
35 }
36 ],
37 "number": 0,
38 "sort": {
39 "unsorted": true,
40 "sorted": true,
41 "empty": true
42 },
43 "empty": true
44}
Get Unread Mobile Notification Count¶
HTTP Request
GET /api/notifications/{userName}/for-mobile/count
📋 Description: Retrieves the count of unread notifications for the specified user, enabling mobile users to quickly assess their notification status and prioritize their responses.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userName |
path |
string |
true |
Name of the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "property1": 0,
3 "property2": 0
4}
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» additionalProperties |
integer(int64) |
false |
none |
none |
Get Notification Count¶
HTTP Request
GET /api/notifications/{userName}/count
📋 Description: Retrieves the total count of notifications for the specified user, enabling efficient monitoring of user engagement and communication within the platform.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userName |
path |
string |
true |
Name of the user |
unread |
query |
boolean |
false |
Indicates whether to count only unread notifications for the specified user, enabling targeted insights into user engagement. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
unread |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "property1": 0,
3 "property2": 0
4}
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
» additionalProperties |
integer(int64) |
false |
none |
none |
Delete Notifications¶
HTTP Request
DELETE /api/notifications/{userName}/all
📋 Description: Deletes all notifications for the specified user, streamlining their notification management and enhancing user experience.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userName |
path |
string |
true |
Name of the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Notification¶
HTTP Request
DELETE /api/notifications/{id}
📋 Description: Deletes a specific notification identified by its unique ID, ensuring the removal of outdated or irrelevant information from the notification system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |