ResponseNotificationTopicDto

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    "application": "NFS",
20    "name": "string",
21    "en_caption": "string",
22    "fr_caption": "string",
23    "priority": "HIGH"
24  }
25}

📄 Description: Data transfer object representing a notification topic for response events, facilitating the management and tracking of communication related to business responses.

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 event or update relevant to the user.

defaultMessage

string

false

write-only

Default message to be displayed in notifications, providing users with essential information regarding updates or alerts.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the response notification.

errors

Errors

false

none

Collection of error messages related to the processing of notifications, providing insights into any issues encountered during the operation.

object

NotificationTopicDto

false

none

Represents the notification topic related to the response, facilitating efficient communication and updates within the system.

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