ResponseNotificationDto

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    "id": 0,
19    "subscribeMessage": {
20      "id": 0,
21      "targetId": "string",
22      "targetType": "string",
23      "topicApplication": "NFS",
24      "topicName": "string",
25      "topicPriority": "HIGH",
26      "topicEnCaption": "string",
27      "topicFrCaption": "string",
28      "username": "string",
29      "action": "SUBSCRIBE",
30      "captionKey": "string",
31      "en_message": "string",
32      "fr_message": "string",
33      "url": "string",
34      "parameters": [
35        {
36          "name": "string",
37          "dataType": "NUMBER",
38          "value": "string"
39        }
40      ],
41      "onlyAfterNow": true,
42      "startTime": "2019-08-24T14:15:22Z",
43      "cronExpression": "string",
44      "endTime": "2019-08-24T14:15:22Z",
45      "content": "string"
46    },
47    "unsubscribeMessage": {
48      "id": 0,
49      "targetId": "string",
50      "targetType": "string",
51      "topicApplication": "NFS",
52      "topicName": "string",
53      "topicPriority": "HIGH",
54      "topicEnCaption": "string",
55      "topicFrCaption": "string",
56      "username": "string",
57      "action": "SUBSCRIBE"
58    },
59    "scheduledTime": "2019-08-24T14:15:22Z",
60    "user": {
61      "id": 0,
62      "accountId": 0,
63      "fullName": "string",
64      "firstName": "string",
65      "lastName": "string",
66      "username": "string",
67      "email": "string",
68      "accountName": "string",
69      "profile": "string"
70    },
71    "state": "ACTIVE",
72    "status": "UNREAD"
73  }
74}

📄 Description: Data transfer object representing a notification response, encapsulating key information related to the status and outcome of a business transaction or event, facilitating effective communication and tracking within enterprise systems.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the notification message detailing the outcome or status of the response, providing essential context for user awareness and action.

defaultMessage

string

false

write-only

Default message to be displayed in response notifications, providing users with essential information regarding the notification context.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the request, facilitating troubleshooting and resolution.

errors

Errors

false

none

Contains details of any errors encountered during the processing of the response notification, facilitating troubleshooting and resolution.

object

NotificationDto

false

none

Represents the response notification details, providing essential information related to the transaction or event being processed.

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