GET api/command/notification
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of NotificationName | Description | Type | Additional information |
---|---|---|---|
Error | string |
None. |
|
NotificationID | integer |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
Enabled | boolean |
None. |
|
SendNow | boolean |
None. |
|
FrequencyPlan | FrequencyPlan |
None. |
|
Groups | GroupSpecs |
None. |
|
MessageSpec | MessageSpec |
None. |
|
ImageBlob | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Error": "sample string 1", "NotificationID": 1, "Name": "sample string 2", "Description": "sample string 3", "StartDate": "2025-06-23T19:24:50.588226+00:00", "EndDate": "2025-06-23T19:24:50.588226+00:00", "Enabled": true, "SendNow": true, "FrequencyPlan": { "Frequency": 0, "Hour": 1, "DaysOfTheWeek": [ 1, 2 ] }, "Groups": { "GroupIDs": [ 1, 2 ], "ClientIDs": [ 1, 2 ] }, "MessageSpec": { "MessageType": 0, "Message": "sample string 1", "Title": "sample string 2" }, "ImageBlob": "sample string 8" }, { "Error": "sample string 1", "NotificationID": 1, "Name": "sample string 2", "Description": "sample string 3", "StartDate": "2025-06-23T19:24:50.588226+00:00", "EndDate": "2025-06-23T19:24:50.588226+00:00", "Enabled": true, "SendNow": true, "FrequencyPlan": { "Frequency": 0, "Hour": 1, "DaysOfTheWeek": [ 1, 2 ] }, "Groups": { "GroupIDs": [ 1, 2 ], "ClientIDs": [ 1, 2 ] }, "MessageSpec": { "MessageType": 0, "Message": "sample string 1", "Title": "sample string 2" }, "ImageBlob": "sample string 8" } ]
application/xml, text/xml
Sample:
<ArrayOfNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Wissp"> <Notification> <Description>sample string 3</Description> <Enabled>true</Enabled> <EndDate>2025-06-23T19:24:50.588226+00:00</EndDate> <FrequencyPlan> <DaysOfTheWeek xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </DaysOfTheWeek> <Frequency>Daily</Frequency> <Hour>1</Hour> </FrequencyPlan> <Groups> <ClientIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </ClientIDs> <GroupIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </GroupIDs> </Groups> <ImageBlob>sample string 8</ImageBlob> <MessageSpec> <Message>sample string 1</Message> <MessageType>SMS</MessageType> <Title>sample string 2</Title> </MessageSpec> <Name>sample string 2</Name> <NotificationID>1</NotificationID> <SendNow>true</SendNow> <StartDate>2025-06-23T19:24:50.588226+00:00</StartDate> <Error>sample string 1</Error> </Notification> <Notification> <Description>sample string 3</Description> <Enabled>true</Enabled> <EndDate>2025-06-23T19:24:50.588226+00:00</EndDate> <FrequencyPlan> <DaysOfTheWeek xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </DaysOfTheWeek> <Frequency>Daily</Frequency> <Hour>1</Hour> </FrequencyPlan> <Groups> <ClientIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </ClientIDs> <GroupIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </GroupIDs> </Groups> <ImageBlob>sample string 8</ImageBlob> <MessageSpec> <Message>sample string 1</Message> <MessageType>SMS</MessageType> <Title>sample string 2</Title> </MessageSpec> <Name>sample string 2</Name> <NotificationID>1</NotificationID> <SendNow>true</SendNow> <StartDate>2025-06-23T19:24:50.588226+00:00</StartDate> <Error>sample string 1</Error> </Notification> </ArrayOfNotification>