ResponseNotificationSubscribeMessageDto

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    "targetId": "string",
20    "targetType": "string",
21    "topicApplication": "NFS",
22    "topicName": "string",
23    "topicPriority": "HIGH",
24    "topicEnCaption": "string",
25    "topicFrCaption": "string",
26    "username": "string",
27    "action": "SUBSCRIBE",
28    "captionKey": "string",
29    "en_message": "string",
30    "fr_message": "string",
31    "url": "string",
32    "parameters": [
33      {
34        "name": "string",
35        "dataType": "NUMBER",
36        "value": "string"
37      }
38    ],
39    "onlyAfterNow": true,
40    "startTime": "2019-08-24T14:15:22Z",
41    "cronExpression": "string",
42    "endTime": "2019-08-24T14:15:22Z",
43    "content": "string"
44  }
45}

📄 Description: Data transfer object representing a subscription request for response notifications, facilitating real-time updates and communication between systems to enhance operational efficiency.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the notification message that provides details about the subscription status or updates related to the response.

defaultMessage

string

false

write-only

Default message to be displayed in notifications, providing essential context for users when a subscription event occurs.

debugMessage

string

false

write-only

Provides detailed information about the status of the subscription request, aiding in troubleshooting and ensuring effective communication with users.

errors

Errors

false

none

Collection of error messages generated during the subscription process, providing insights for troubleshooting and resolution.

object

NotificationSubscribeMessageDto

false

none

Represents the notification object associated with the subscription response, facilitating effective communication and event tracking 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