ResponseNotificationUnsubscribeMessageDto¶
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 }
29}
📄 Description: Data transfer object representing a notification unsubscribe request, enabling users to opt-out of specific communication channels while maintaining compliance with user preferences and data privacy regulations.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
code |
string |
false |
none |
Code identifier for the resource |
message |
string |
false |
write-only |
Textual content of the notification message confirming the successful unsubscription from the service. |
defaultMessage |
string |
false |
write-only |
Default message to be displayed in notifications when a user unsubscribes from a service. |
debugMessage |
string |
false |
write-only |
Contains a detailed message for debugging purposes related to the unsubscribe notification process. |
errors |
false |
none |
Contains details of any errors encountered during the unsubscribe notification process, ensuring effective resolution and user experience. |
|
object |
false |
none |
Represents the details of the unsubscribe notification response, facilitating the management of user preferences 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 |