Notification Subscribe Message¶

Notification Subscribe Message - Get¶

HTTP Request

GET /api/v1/notification/subscribe/{id}

📋 Description: Subscribes a user to notifications for a specific resource identified by the provided ID, enabling timely updates and engagement with relevant information.

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Status	Meaning	Description	Schema
200	OK	OK	ResponseNotificationSubscribeMessageDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  }
}

Notification Subscribe Message - Update¶

HTTP Request

PUT /api/v1/notification/subscribe/{id}

📋 Description: Updates the subscription status for a specific notification identified by the provided ID, enabling users to manage their notification preferences effectively.

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	NotificationSubscribeMessageDto	true	Request body containing subscription details, including user preferences and notification settings, to manage the notification subscription for the specified identifier.

Body Parameters

{
  "id": 0,
  "targetId": "string",
  "targetType": "string",
  "topicApplication": "NFS",
  "topicName": "string",
  "topicPriority": "HIGH",
  "topicEnCaption": "string",
  "topicFrCaption": "string",
  "username": "string",
  "action": "SUBSCRIBE",
  "captionKey": "string",
  "en_message": "string",
  "fr_message": "string",
  "url": "string",
  "parameters": [
    {
      "name": "string",
      "dataType": "NUMBER",
      "value": "string"
    }
  ],
  "onlyAfterNow": true,
  "startTime": "2019-08-24T14:15:22Z",
  "cronExpression": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "content": "string"
}

Status	Meaning	Description	Schema
200	OK	OK	ResponseNotificationSubscribeMessageDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  }
}

Notification Subscribe Message - Create Or Update Bulk¶

HTTP Request

PUT /api/v1/notification/subscribe/createOrUpdate/bulk

📋 Description: Creates or updates multiple notification subscriptions in bulk, enabling efficient management of user preferences and enhancing communication strategies.

Name	In	Type	Required	Description
body	body	NotificationSubscribeMessageDto	true	Request body containing a list of subscription details for bulk creation or updates of notifications, including recipient information and notification preferences.

Body Parameters

[
  {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  }
]

Status	Meaning	Description	Schema
200	OK	OK	ResponseListNotificationSubscribeMessageDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    }
  ]
}

Notification Subscribe Message - Create Or Update¶

HTTP Request

PUT /api/v1/notification/subscribe/createOrUpdate

📋 Description: Creates or updates a subscription for notifications, ensuring users receive timely updates relevant to their preferences and business needs.

Name	In	Type	Required	Description
body	body	NotificationSubscribeMessageDto	true	Request body containing subscription details, including user preferences and notification settings, for creating or updating a notification subscription.

Body Parameters

{
  "id": 0,
  "targetId": "string",
  "targetType": "string",
  "topicApplication": "NFS",
  "topicName": "string",
  "topicPriority": "HIGH",
  "topicEnCaption": "string",
  "topicFrCaption": "string",
  "username": "string",
  "action": "SUBSCRIBE",
  "captionKey": "string",
  "en_message": "string",
  "fr_message": "string",
  "url": "string",
  "parameters": [
    {
      "name": "string",
      "dataType": "NUMBER",
      "value": "string"
    }
  ],
  "onlyAfterNow": true,
  "startTime": "2019-08-24T14:15:22Z",
  "cronExpression": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "content": "string"
}

Status	Meaning	Description	Schema
200	OK	OK	ResponseNotificationSubscribeMessageDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  }
}

Notification Subscribe Message - Bulk Update¶

HTTP Request

PUT /api/v1/notification/subscribe/bulk

📋 Description: Updates the subscription status for multiple notifications in bulk, allowing businesses to efficiently manage user preferences and enhance communication strategies.

Name	In	Type	Required	Description
body	body	NotificationSubscribeMessageDto	true	Request body containing an array of subscription details for multiple notifications, including user identifiers and notification preferences.

Body Parameters

[
  {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  }
]

Status	Meaning	Description	Schema
200	OK	OK	ResponseListNotificationSubscribeMessageDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    }
  ]
}

Notification Subscribe Message - Search¶

HTTP Request

POST /api/v1/notification/subscribe/search

📋 Description: Subscribes a user to notifications based on specified search criteria, enabling timely updates relevant to their interests and preferences.

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	NotificationSubscribeMessageDtoFilter	false	Request body containing the subscription criteria and user preferences for notification alerts.

Default Values¶

Parameter	Default	Type
page	`0`	query
size	`100`	query
sort	`["createdAt,ASC"]`	query

Parameter Constraints¶

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "targetIdEqual": "string",
  "targetIdLike": "string",
  "targetTypeEqual": "string",
  "targetTypeLike": "string"
}

Status	Meaning	Description	Schema
200	OK	OK	PageNotificationSubscribeMessageDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Notification Subscribe Message - Find All¶

HTTP Request

GET /api/v1/notification/subscribe

📋 Description: Subscribes a user to notifications, enabling them to receive updates and alerts relevant to their interests and activities within the application.

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently manage large sets of subscription notifications.

Status	Meaning	Description	Schema
200	OK	OK	PageNotificationSubscribeMessageDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Notification Subscribe Message - Subscribe¶

HTTP Request

POST /api/v1/notification/subscribe

📋 Description: Subscribes a user to notifications, enabling them to receive timely updates and alerts relevant to their interests or activities within the platform.

Name	In	Type	Required	Description
body	body	NotificationSubscribeMessageDto	true	Request body containing the subscription details for notifications, including user preferences and contact information.

Body Parameters

[
  {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  }
]

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "subscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    },
    "unsubscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE"
    },
    "scheduledTime": "2019-08-24T14:15:22Z",
    "user": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "state": "ACTIVE",
    "status": "UNREAD"
  }
]

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[NotificationDto]	false	none	[Data transfer object representing a notification that conveys important updates or alerts to users, facilitating timely communication and enhancing user engagement within the application.]
» id	integer(int64)	false	none	Unique identifier for the resource
» subscribeMessage	NotificationSubscribeMessageDto	false	none	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.
»» 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.
»»» name	string	false	none	Name of the resource
»»» dataType	string	false	none	Type of the data
»»» value	string	false	none	Represents the specific value associated with a notification parameter, used to customize alerts and communications 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.
» unsubscribeMessage	NotificationUnsubscribeMessageDto	false	none	Data transfer object representing a user’s request to unsubscribe from notifications, facilitating the management of user preferences and enhancing engagement strategies.
»» 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 the user wishes to unsubscribe from notifications.
»» topicName	string	true	none	Name of the topic
»» topicPriority	string	true	none	Priority of the topic
»» topicEnCaption	string	false	none	Descriptive label for the topic in English associated with the notification unsubscribe message, facilitating clear communication with users.
»» topicFrCaption	string	false	none	Caption for the topic in French, used to provide localized content for notifications related to user subscriptions.
»» username	string	true	none	Unique identifier for the user opting to unsubscribe from notifications, ensuring accurate processing of subscription preferences.
»» action	string	false	none	Specifies the type of action to be taken in relation to the notification unsubscribe request.
» scheduledTime	string(date-time)	false	none	Time of the scheduled
» user	UserDto	false	none	Data transfer object representing a user profile, encapsulating essential attributes such as user identification, contact information, and role within the organization to facilitate user management and access control.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» accountId	integer(int64)	false	none	Unique identifier for the account
»» fullName	string	false	none	Full name of the resource
»» firstName	string	false	none	Name of the first
»» lastName	string	false	none	Name of the last
»» username	string	true	none	Represents the unique username associated with a user account, essential for authentication and user identification within the system.
»» email	string	false	none	Email address of the user, used for communication and account verification purposes within the system.
»» accountName	string	false	none	Name of the account
»» profile	string	false	none	Represents the user’s profile information, providing essential details for personalized interactions within the application.
» state	string	false	none	Represents the current status of the notification, indicating its progress within the workflow.
» status	string	false	none	Status of the resource

Enumerated Values

Attribute	Value
action	SUBSCRIBE, UNSUBSCRIBE
dataType	CURRENCY, DATE, DATE_TIME, NUMBER, TEXT
state	ACTIVE, DECOMMISSIONED
status	READ, UNREAD
topicApplication	AP, FOS, NFS, SPB, SSB
topicPriority	HIGH, LOW, MEDIUM

Notification Subscribe Message¶

Notification Subscribe Message - Get¶

Parameters

Responses

Notification Subscribe Message - Update¶

Parameters

Responses

Notification Subscribe Message - Create Or Update Bulk¶

Parameters

Responses

Notification Subscribe Message - Create Or Update¶

Parameters

Responses

Notification Subscribe Message - Bulk Update¶

Parameters

Responses

Notification Subscribe Message - Search¶

Parameters

Default Values¶

Parameter Constraints¶

Responses

Notification Subscribe Message - Find All¶

Parameters

Responses

Notification Subscribe Message - Subscribe¶

Parameters

Responses

Response Schema

Enumerated Values