Notification Topic¶
Notification Topic - Get¶
HTTP Request
GET /api/v1/notification-topic/{id}
📋 Description: Retrieves details of a specific notification topic identified by the provided ID, enabling users to access relevant information for effective communication management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "application": "NFS",
17 "name": "string",
18 "en_caption": "string",
19 "fr_caption": "string",
20 "priority": "HIGH"
21 }
22}
Notification Topic - Update¶
HTTP Request
PUT /api/v1/notification-topic/{id}
📋 Description: Updates the details of a specified notification topic, allowing businesses to manage and refine their communication strategies effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated notification topic details, including title, description, and associated metadata for effective communication management. |
Body Parameters
1{
2 "id": 0,
3 "application": "NFS",
4 "name": "string",
5 "en_caption": "string",
6 "fr_caption": "string",
7 "priority": "HIGH"
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "application": "NFS",
17 "name": "string",
18 "en_caption": "string",
19 "fr_caption": "string",
20 "priority": "HIGH"
21 }
22}
Notification Topic - Patch¶
HTTP Request
PATCH /api/v1/notification-topic/{id}
📋 Description: Updates the specified notification topic by applying partial modifications to its attributes, enabling businesses to refine their communication strategies effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated notification topic details, including title, description, and status, to ensure accurate communication management. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "application": "NFS",
18 "name": "string",
19 "en_caption": "string",
20 "fr_caption": "string",
21 "priority": "HIGH"
22 }
23 ]
24}
Notification Topic - Bulk Update¶
HTTP Request
PUT /api/v1/notification-topic/bulk
📋 Description: Updates multiple notification topics in bulk, allowing for efficient management of notification settings across various channels.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of notification topic objects, each specifying the details for bulk updates to notification preferences. |
Body Parameters
1[
2 {
3 "id": 0,
4 "application": "NFS",
5 "name": "string",
6 "en_caption": "string",
7 "fr_caption": "string",
8 "priority": "HIGH"
9 }
10]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "application": "NFS",
18 "name": "string",
19 "en_caption": "string",
20 "fr_caption": "string",
21 "priority": "HIGH"
22 }
23 ]
24}
Notification Topic - Search¶
HTTP Request
POST /api/v1/notification-topic/search
📋 Description: Submits a search request for notification topics, enabling users to efficiently locate and manage relevant notifications within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
notificationTopicDtoFilter |
query |
true |
none |
|
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 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 "application": "NFS",
22 "name": "string",
23 "en_caption": "string",
24 "fr_caption": "string",
25 "priority": "HIGH"
26 }
27 ],
28 "number": 0,
29 "sort": {
30 "unsorted": true,
31 "sorted": true,
32 "empty": true
33 },
34 "first": true,
35 "last": true,
36 "empty": true
37}
Notification Topic - Find All¶
HTTP Request
GET /api/v1/notification-topic
📋 Description: Retrieves the list of available notification topics, enabling users to manage and subscribe to relevant alerts within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to retrieve notifications in manageable segments for improved data handling and user experience. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 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 "application": "NFS",
22 "name": "string",
23 "en_caption": "string",
24 "fr_caption": "string",
25 "priority": "HIGH"
26 }
27 ],
28 "number": 0,
29 "sort": {
30 "unsorted": true,
31 "sorted": true,
32 "empty": true
33 },
34 "first": true,
35 "last": true,
36 "empty": true
37}