Notification¶
Mark Notification Read¶
HTTP Request
POST /api/notifications/{id}/read
📋 Description: Marks the specified notification as read, allowing users to manage their notification status effectively and maintain an organized communication flow.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Notify Work Order Created¶
HTTP Request
POST /api/notifications/workorder
📋 Description: Creates a new work order notification, enabling timely communication and updates regarding work order status within the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the work order notification details, including relevant identifiers, status updates, and associated metadata for effective tracking and management. |
» additionalProperties |
body |
object |
false |
none |
Body Parameters
1{
2 "property1": {},
3 "property2": {}
4}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Unread Count By Type¶
HTTP Request
GET /api/notifications/{username}/count-by-type
📋 Description: Retrieves the count of notifications categorized by type for the specified user, enabling efficient management of user engagement and communication strategies.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
username |
path |
string |
true |
Specifies the username for which the notification count by type is being requested, enabling targeted insights into user-specific notifications. |
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 Notifications¶
HTTP Request
GET /api/notifications/{userName}
📋 Description: Retrieves notifications for the specified user, enabling personalized updates and alerts to enhance user engagement and communication.
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 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "createdBy": "string",
22 "createdAt": "2019-08-24T14:15:22Z",
23 "title": "string",
24 "forUserId": "string",
25 "byUserId": "string",
26 "message": "string",
27 "redirectTo": "string",
28 "displayId": "string",
29 "createdTime": "string",
30 "type": "string",
31 "read": true
32 }
33 ],
34 "number": 0,
35 "sort": {
36 "unsorted": true,
37 "sorted": true,
38 "empty": true
39 },
40 "first": true,
41 "last": true,
42 "empty": true
43}
Get Notification Count¶
HTTP Request
GET /api/notifications/{userName}/count
📋 Description: Retrieves the total count of notifications for the specified user, enabling efficient management and prioritization of user alerts.
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 efficient tracking of pending communications. |
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 All User Notifications¶
HTTP Request
DELETE /api/notifications/{userName}/all
📋 Description: Deletes all notifications for the specified user, allowing for efficient management of notification clutter 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 that users can manage their notification preferences effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |