nevisIDM Notification REST API (v1)
Introduction
The nevisIDM Notification REST API enables to send notifications to users.
Notification sending ¶
Service to send notification to users.
Send Notification To User DTO
The Send Notification To User DTO has the following parameters:
-
clientExtId - The external ID of the client to which the user belongs (string).
-
userExtId - The external ID of the user to send the notification (string).
-
notificationType - Communication event type (string). Supported values are userNotification1-userNotification20.
-
sendingMethod - Array of sending methods. Order of the values also defines the fallback order (array of string, default:Email). Supported values are Email and HTMLemail.
-
async - Defines whether the communication should happen immediately or via the EventQueue (boolean, default:false).
-
placeholders - Language specific placeholder key-value pairs that also contains a languageIndependent part to be used for all languages. All placeholders have to start with EXTERNAL prefix (map<string, map<string, string>>).
Send notifications ¶
Send notification to userPOST/
Send notification to a user with the defined notificationType
and sendingMethod
.
Required permissions
AccessControl.UserView
Example URI
Headers
Content-Type: application/json
Body
{
"clientExtId": "100",
"userExtId": "88881051",
"notificationType": "UserNotification2",
"sendingMethod": [
"Email"
],
"async": false,
"placeholders": {
"en": {
"EXTERNAL_CITY": "Vienna"
},
"de": {
"EXTERNAL_CITY": "Wien"
},
"languageIndependent": {
"EXTERNAL_IP_ADDRESS": "173.170.190.74"
}
}
}
204
Headers
Content-Type: application/json
Notification types ¶
Get notification typesGET/system/notification-types/
Returns the available notification types.
Required permissions
No permissions are required to use this service.
Example URI
200
Headers
Content-Type: application/json
Body
{
"items": [
"userNotification1",
"userNotification2",
"userNotification3",
"userNotification4",
"userNotification5",
"userNotification6",
"userNotification7",
"userNotification8",
"userNotification9",
"userNotification10",
"userNotification11",
"userNotification12",
"userNotification13",
"userNotification14",
"userNotification15",
"userNotification16",
"userNotification17",
"userNotification18",
"userNotification19",
"userNotification20"
]
}