ResponseListNotificationSubscribeMessageDto

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

📄 Description: Data transfer object representing a subscription notification response list, designed to facilitate the management and tracking of user subscriptions within the notification system.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the notification message related to the subscription status, providing essential updates for user engagement.

defaultMessage

string

false

write-only

Default message to be displayed in notifications for subscribed users, ensuring consistent communication across the platform.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the subscription process, aiding in troubleshooting and ensuring effective communication with users.

errors

Errors

false

none

Collection of error messages related to the subscription process, providing insights into any issues encountered during the notification subscription.

object

[NotificationSubscribeMessageDto]

false

none

An array of notification subscription messages that provides a structured list of responses relevant to the user’s subscription preferences.

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