ResponseListNotificationDto

Example Json Object

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "errorMessage": "string",
11        "source": {},
12        "field": "string",
13        "errorKey": "string"
14      }
15    ]
16  },
17  "object": [
18    {
19      "id": 0,
20      "subscribeMessage": {
21        "id": 0,
22        "targetId": "string",
23        "targetType": "string",
24        "topicApplication": "NFS",
25        "topicName": "string",
26        "topicPriority": "HIGH",
27        "topicEnCaption": "string",
28        "topicFrCaption": "string",
29        "username": "string",
30        "action": "SUBSCRIBE",
31        "captionKey": "string",
32        "en_message": "string",
33        "fr_message": "string",
34        "url": "string",
35        "parameters": [
36          {
37            "name": "string",
38            "dataType": "NUMBER",
39            "value": "string"
40          }
41        ],
42        "onlyAfterNow": true,
43        "startTime": "2019-08-24T14:15:22Z",
44        "cronExpression": "string",
45        "endTime": "2019-08-24T14:15:22Z",
46        "content": "string"
47      },
48      "unsubscribeMessage": {
49        "id": 0,
50        "targetId": "string",
51        "targetType": "string",
52        "topicApplication": "NFS",
53        "topicName": "string",
54        "topicPriority": "HIGH",
55        "topicEnCaption": "string",
56        "topicFrCaption": "string",
57        "username": "string",
58        "action": "SUBSCRIBE"
59      },
60      "scheduledTime": "2019-08-24T14:15:22Z",
61      "user": {
62        "id": 0,
63        "accountId": 0,
64        "fullName": "string",
65        "firstName": "string",
66        "lastName": "string",
67        "username": "string",
68        "email": "string",
69        "accountName": "string",
70        "profile": "string"
71      },
72      "state": "ACTIVE",
73      "status": "UNREAD"
74    }
75  ]
76}

📄 Description: Data transfer object representing a collection of notifications related to response activities, designed to facilitate efficient communication and tracking within business processes.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the notification message providing relevant updates or information to the user.

defaultMessage

string

false

write-only

Default message to be displayed in notifications when no specific message is provided, ensuring consistent communication with users.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the notification, aiding in troubleshooting and system optimization.

errors

Errors

false

none

Collection of error messages generated during the processing of the request, providing insights into any issues encountered.

object

[NotificationDto]

false

none

An array of notification response objects that encapsulate the details of each notification within the response list.

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED