NotificationDto

Example Json Object

 1{
 2  "id": 0,
 3  "subscribeMessage": {
 4    "id": 0,
 5    "targetId": "string",
 6    "targetType": "string",
 7    "topicApplication": "NFS",
 8    "topicName": "string",
 9    "topicPriority": "HIGH",
10    "topicEnCaption": "string",
11    "topicFrCaption": "string",
12    "username": "string",
13    "action": "SUBSCRIBE",
14    "captionKey": "string",
15    "en_message": "string",
16    "fr_message": "string",
17    "url": "string",
18    "parameters": [
19      {
20        "name": "string",
21        "dataType": "NUMBER",
22        "value": "string"
23      }
24    ],
25    "onlyAfterNow": true,
26    "startTime": "2019-08-24T14:15:22Z",
27    "cronExpression": "string",
28    "endTime": "2019-08-24T14:15:22Z",
29    "content": "string"
30  },
31  "unsubscribeMessage": {
32    "id": 0,
33    "targetId": "string",
34    "targetType": "string",
35    "topicApplication": "NFS",
36    "topicName": "string",
37    "topicPriority": "HIGH",
38    "topicEnCaption": "string",
39    "topicFrCaption": "string",
40    "username": "string",
41    "action": "SUBSCRIBE"
42  },
43  "scheduledTime": "2019-08-24T14:15:22Z",
44  "user": {
45    "id": 0,
46    "accountId": 0,
47    "fullName": "string",
48    "firstName": "string",
49    "lastName": "string",
50    "username": "string",
51    "email": "string",
52    "accountName": "string",
53    "profile": "string"
54  },
55  "state": "ACTIVE",
56  "status": "UNREAD"
57}

📄 Description: Data transfer object representing a notification that conveys important updates or alerts to users, facilitating timely communication and enhancing user engagement within the application.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

subscribeMessage

NotificationSubscribeMessageDto

false

none

Message content for subscription notifications, facilitating timely communication with users regarding updates or changes.

unsubscribeMessage

NotificationUnsubscribeMessageDto

false

none

Message content that informs users about the successful unsubscription from notifications.

scheduledTime

string(date-time)

false

none

Time of the scheduled

user

UserDto

false

none

Represents the user associated with the notification, facilitating personalized communication and engagement within the system.

state

string

false

none

Represents the current status of the notification, indicating its progress within the workflow.

status

string

false

none

Status of the resource

Enumerated Values

Attribute

Value

state

ACTIVE, DECOMMISSIONED

status

READ, UNREAD