All Verbs | /service/CalendarNotification/{username} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
notification | query | Notification | No | |
channel | query | NChannel | No | |
username | path | string | 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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
channel_id | form | string | No | |
callback_url | form | string | No | |
filters | form | Filter | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
calendar_ids | form | string[] | No | |
only_managed | form | bool | 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/CalendarNotification/{username} HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
notification:
{
type: String,
changes_since: 0001-01-01
},
channel:
{
channel_id: String,
callback_url: String,
filters:
{
calendar_ids:
[
String
],
only_managed: False
}
},
username: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { notification: { type: String, changes_since: 0001-01-01 }, channel: { channel_id: String, callback_url: String, filters: { calendar_ids: [ String ], only_managed: False } }, username: String }