Notification
The login token
Specifications of a Notification object.
Notificaiton ID. Unique and assigned by the system.
Timestamp UTC of the notification.
Severity level. May be one of the following: INFO: the notification is an information AWARD: the notification is an award WARN: the notification is a warning ALERT: the notification is an alert
Notification type. /// May be one of the following: BROADCAST: the notification is a broadcast TENANT: the notification is a tenant notification USER: the notification is a user notification
Tenant ID of the notification.
The Username of the user that the notification is addressed to.
The date and time from which the notification is valid. Used when creating and modifying the notification. Ignored otherwise.
The date and time until which the notification is valid. Used when creating and modifying the notification. Ignored otherwise.
POST /api/v2/Notifications/{strToken} HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 301
{
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
}
Success
{
"notification": {
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
},
"requestID": 1,
"requestDateTime": "2025-07-23T11:30:34.652Z",
"resultCode": 1,
"resultMessage": "text"
}
The login token
The ID of the notification
GET /api/v2/Notifications/{strToken}/{strNotificationID} HTTP/1.1
Host:
Accept: */*
Success
{
"notification": {
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
},
"requestID": 1,
"requestDateTime": "2025-07-23T11:30:34.652Z",
"resultCode": 1,
"resultMessage": "text"
}
The login token
The ID of the notification
DELETE /api/v2/Notifications/{strToken}/{strNotificationID} HTTP/1.1
Host:
Accept: */*
Success
{
"requestID": 1,
"requestDateTime": "2025-07-23T11:30:34.652Z",
"resultCode": 1,
"resultMessage": "text"
}
Specifications of a Notification object.
Notificaiton ID. Unique and assigned by the system.
Timestamp UTC of the notification.
Severity level. May be one of the following: INFO: the notification is an information AWARD: the notification is an award WARN: the notification is a warning ALERT: the notification is an alert
Notification type. /// May be one of the following: BROADCAST: the notification is a broadcast TENANT: the notification is a tenant notification USER: the notification is a user notification
Tenant ID of the notification.
The Username of the user that the notification is addressed to.
The date and time from which the notification is valid. Used when creating and modifying the notification. Ignored otherwise.
The date and time until which the notification is valid. Used when creating and modifying the notification. Ignored otherwise.
PATCH /api/v2/Notifications/{strToken}/{strNotificationID} HTTP/1.1
Host:
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 301
{
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
}
Success
{
"notification": {
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
},
"requestID": 1,
"requestDateTime": "2025-07-23T11:30:34.652Z",
"resultCode": 1,
"resultMessage": "text"
}
The login token
Filters the notifications to show. May be one of the following:ACTIVE_AND_FUTURE: Only active and future notificationsONLY_FUTURE : Only future notificationsALL : All notifications
ACTIVE_AND_FUTURE
GET /api/v2/ListAllNotifications/{strToken}/{notificationsFilter} HTTP/1.1
Host:
Accept: */*
Success
{
"notifications": [
{
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
}
],
"requestID": 1,
"requestDateTime": "2025-07-23T11:30:34.652Z",
"resultCode": 1,
"resultMessage": "text"
}
The login token
GET /api/v2/UserNotifications/{strToken} HTTP/1.1
Host:
Accept: */*
Success
{
"notifications": [
{
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
}
],
"requestID": 1,
"requestDateTime": "2025-07-23T11:30:34.652Z",
"resultCode": 1,
"resultMessage": "text"
}
The name of the Tenant
GET /api/v2/TenantNotifications/{tenantName} HTTP/1.1
Host:
Accept: */*
Success
{
"notifications": [
{
"notificationID": "text",
"timestamp": "2025-07-23T11:30:34.652Z",
"severity": "text",
"texts": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"additionalInfo": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"type": "text",
"tenant": "text",
"userName": "text",
"validFrom": "2025-07-23T11:30:34.652Z",
"validTo": "2025-07-23T11:30:34.652Z"
}
],
"requestID": 1,
"requestDateTime": "2025-07-23T11:30:34.652Z",
"resultCode": 1,
"resultMessage": "text"
}