NotificationSubscribeMessageDto

Example Json Object

 1{
 2  "id": 0,
 3  "targetId": "string",
 4  "targetType": "string",
 5  "topicApplication": "NFS",
 6  "topicName": "string",
 7  "topicPriority": "HIGH",
 8  "topicEnCaption": "string",
 9  "topicFrCaption": "string",
10  "username": "string",
11  "action": "SUBSCRIBE",
12  "captionKey": "string",
13  "en_message": "string",
14  "fr_message": "string",
15  "url": "string",
16  "parameters": [
17    {
18      "name": "string",
19      "dataType": "NUMBER",
20      "value": "string"
21    }
22  ],
23  "onlyAfterNow": true,
24  "startTime": "2019-08-24T14:15:22Z",
25  "cronExpression": "string",
26  "endTime": "2019-08-24T14:15:22Z",
27  "content": "string"
28}

📄 Description: Data transfer object representing a subscription request for notifications, enabling users to receive timely updates and alerts relevant to their interests or activities within the platform.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

targetId

string

true

none

Unique identifier for the target

targetType

string

true

none

Type of the target

topicApplication

string

true

none

Specifies the application topic for which notifications are being subscribed, enabling targeted communication within the system.

topicName

string

true

none

Name of the topic

topicPriority

string

true

none

Priority of the topic

topicEnCaption

string

false

none

Descriptive caption of the topic in English, used to provide clarity and context for notifications related to subscription messages.

topicFrCaption

string

false

none

Caption for the French version of the notification topic, used to enhance user engagement in multilingual communication.

username

string

true

none

Unique identifier for the user subscribing to notifications, ensuring personalized communication and engagement within the platform.

action

string

false

none

Specifies the type of action to be performed in the notification subscription process.

captionKey

string

false

none

Key used to retrieve the localized caption for notifications, ensuring effective communication with users in their preferred language.

en_message

string

false

none

Contains the English language message for the notification subscription, facilitating clear communication with users.

fr_message

string

false

none

Contains the message content for subscription notifications, facilitating effective communication between the system and users.

url

string

false

none

Specifies the endpoint URL to which notifications will be sent upon subscription.

parameters

[NotificationParameterDto]

false

none

An array of parameters that define the specific criteria for subscribing to notifications within the system.

onlyAfterNow

boolean

false

none

Indicates whether notifications should only be sent for events occurring after the current time, allowing users to manage their alert preferences effectively.

startTime

string(date-time)

false

none

Time of the start

cronExpression

string

false

none

Specifies the schedule for recurring notifications in a cron format, enabling precise timing for automated alerts.

endTime

string(date-time)

false

none

Time of the end

content

string

false

none

Contains the message content for the notification subscription, enabling effective communication with users.

Enumerated Values

Attribute

Value

action

SUBSCRIBE, UNSUBSCRIBE

topicApplication

AP, FOS, NFS, SPB, SSB

topicPriority

HIGH, LOW, MEDIUM