All Verbs | /service/NotifyAll | ||
---|---|---|---|
All Verbs | /service/util/NotifyAll | ||
All Verbs | /service/Notification/NotifyAll |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Channel | form | string | No | |
Title | form | string | No | |
Text | form | string | No | |
Sticky | form | bool | No | |
Countdown | form | bool | No | |
Image | form | string | No | |
Icon | form | string | No | |
Hue | form | Hues | No | |
HorizontalAlignment | form | HorizontalAlignments | No | |
VerticalAlignment | form | VerticalAlignments | No | |
Shown | form | TimeSpan | No | |
TimeToLive | form | double | No | |
Type | form | NotificationTypes | No | |
Sent | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Channel | form | string | No | |
Title | form | string | No | |
Text | form | string | No | |
Sticky | form | bool | No | |
Countdown | form | bool | No | |
Image | form | string | No | |
Icon | form | string | No | |
Hue | form | Hues | No | |
HorizontalAlignment | form | HorizontalAlignments | No | |
VerticalAlignment | form | VerticalAlignments | No | |
Shown | form | TimeSpan | No | |
TimeToLive | form | double | No | |
Type | form | NotificationTypes | No | |
Sent | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/NotifyAll HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
channel: String,
title: String,
text: String,
sticky: False,
countdown: False,
image: String,
icon: String,
hue: Light,
horizontalAlignment: Left,
verticalAlignment: Top,
shown: PT0S,
timeToLive: 0,
type: Verbose,
sent: 0001-01-01
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { channel: String, title: String, text: String, sticky: False, countdown: False, image: String, icon: String, hue: Light, horizontalAlignment: Left, verticalAlignment: Top, shown: PT0S, timeToLive: 0, type: Verbose, sent: 0001-01-01 }