Event Notifications for Tenant
Tenant Var Code
OK
The unique identifier of the event notification
Free text with notification name
Optional free text that is used in messages sent to recipients
Used for disabling of existing notifications
Logical expression which specifies when the notifications should be sent (for detailed info see Others tab)
Time zone that is used in case any time events are used in expression (for list of valid time zones see Others tab)
Whether an alert should be raised in addition to notifying recipients
Notification severity (use "0" for None, "1" for Warning, "2" for High)
When device type is set the notification applies to all devices of the device type. This field is valid for tenant notification only
Comma delimited list of device IDs the notification applies to or null for all devices. This field is valid for tenant notification only
GET /V2/{tenantVarCode}/eventnotifications HTTP/1.1
Accept: */*
OK
[
{
"NotificationId": "text",
"NotificationName": "text",
"NotificationText": "text",
"NotificationDisabled": true,
"Recipients": [
{
"Type": "DeviceList",
"TenantCode": "text",
"ContactId": "text",
"ContactDetailId": "text",
"ListId": "text",
"MessagingAddress": "text",
"Radius": "text",
"ReportingFrequency": "text",
"Interval": "text",
"GroupId": "text"
}
],
"EventsExpression": "text",
"TimeZoneId": "text",
"RaiseAlert": true,
"Severity": "text",
"DeviceType": "text",
"Devices": "text"
}
]Tenant Var Code
The unique identifier of the event notification
Free text with notification name
Optional free text that is used in messages sent to recipients
Used for disabling of existing notifications
Logical expression which specifies when the notifications should be sent (for detailed info see Others tab)
Time zone that is used in case any time events are used in expression (for list of valid time zones see Others tab)
Whether an alert should be raised in addition to notifying recipients
Notification severity (use "0" for None, "1" for Warning, "2" for High)
When device type is set the notification applies to all devices of the device type. This field is valid for tenant notification only
Comma delimited list of device IDs the notification applies to or null for all devices. This field is valid for tenant notification only
OK
No content
POST /V2/{tenantVarCode}/eventnotifications HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 446
{
"NotificationId": "text",
"NotificationName": "text",
"NotificationText": "text",
"NotificationDisabled": true,
"Recipients": [
{
"Type": "DeviceList",
"TenantCode": "text",
"ContactId": "text",
"ContactDetailId": "text",
"ListId": "text",
"MessagingAddress": "text",
"Radius": "text",
"ReportingFrequency": "text",
"Interval": "text",
"GroupId": "text"
}
],
"EventsExpression": "text",
"TimeZoneId": "text",
"RaiseAlert": true,
"Severity": "text",
"DeviceType": "text",
"Devices": "text"
}OK
No content
Tenant Var Code
Notification Id
OK
The unique identifier of the event notification
Free text with notification name
Optional free text that is used in messages sent to recipients
Used for disabling of existing notifications
Logical expression which specifies when the notifications should be sent (for detailed info see Others tab)
Time zone that is used in case any time events are used in expression (for list of valid time zones see Others tab)
Whether an alert should be raised in addition to notifying recipients
Notification severity (use "0" for None, "1" for Warning, "2" for High)
When device type is set the notification applies to all devices of the device type. This field is valid for tenant notification only
Comma delimited list of device IDs the notification applies to or null for all devices. This field is valid for tenant notification only
GET /V2/{tenantVarCode}/eventnotifications/{notificationId} HTTP/1.1
Accept: */*
OK
{
"NotificationId": "text",
"NotificationName": "text",
"NotificationText": "text",
"NotificationDisabled": true,
"Recipients": [
{
"Type": "DeviceList",
"TenantCode": "text",
"ContactId": "text",
"ContactDetailId": "text",
"ListId": "text",
"MessagingAddress": "text",
"Radius": "text",
"ReportingFrequency": "text",
"Interval": "text",
"GroupId": "text"
}
],
"EventsExpression": "text",
"TimeZoneId": "text",
"RaiseAlert": true,
"Severity": "text",
"DeviceType": "text",
"Devices": "text"
}Tenant Var Code
Notification Id
The unique identifier of the event notification
Free text with notification name
Optional free text that is used in messages sent to recipients
Used for disabling of existing notifications
Logical expression which specifies when the notifications should be sent (for detailed info see Others tab)
Time zone that is used in case any time events are used in expression (for list of valid time zones see Others tab)
Whether an alert should be raised in addition to notifying recipients
Notification severity (use "0" for None, "1" for Warning, "2" for High)
When device type is set the notification applies to all devices of the device type. This field is valid for tenant notification only
Comma delimited list of device IDs the notification applies to or null for all devices. This field is valid for tenant notification only
OK
No content
PUT /V2/{tenantVarCode}/eventnotifications/{notificationId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 446
{
"NotificationId": "text",
"NotificationName": "text",
"NotificationText": "text",
"NotificationDisabled": true,
"Recipients": [
{
"Type": "DeviceList",
"TenantCode": "text",
"ContactId": "text",
"ContactDetailId": "text",
"ListId": "text",
"MessagingAddress": "text",
"Radius": "text",
"ReportingFrequency": "text",
"Interval": "text",
"GroupId": "text"
}
],
"EventsExpression": "text",
"TimeZoneId": "text",
"RaiseAlert": true,
"Severity": "text",
"DeviceType": "text",
"Devices": "text"
}OK
No content
Tenant Var Code
Notification Id
OK
No content
DELETE /V2/{tenantVarCode}/eventnotifications/{notificationId} HTTP/1.1
Accept: */*
OK
No content
Last updated