GET api/Push/Get
Get all PUSH subscriptions
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Get all PUSH subscriptions
Collection of PushSubscriberModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Leave empty (null) when creating new subscription |
integer32 |
None. |
Name |
Optional name of subscription |
string |
String length: inclusive between 0 and 50 |
Url |
Url to push receiver webservice |
string |
String length: inclusive between 1 and 256 |
GroupId |
Optional GroupdId. Default value is group id of requesting user |
integer32 |
Null values possible. |
PushUtilization |
Include utilization data in push messages |
boolean |
Null values possible. |
StatusEmail |
Email will be sent to this address if subscription is suspended |
string |
None. |
Suspended |
Suspended status (read only) |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": 1, "Name": "sample string 2", "Url": "sample string 3", "GroupId": 1, "PushUtilization": true, "StatusEmail": "sample string 4", "Suspended": true }, { "Id": 1, "Name": "sample string 2", "Url": "sample string 3", "GroupId": 1, "PushUtilization": true, "StatusEmail": "sample string 4", "Suspended": true } ]
application/xml, text/xml
Sample:
<ArrayOfPushSubscriberModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models"> <PushSubscriberModel> <GroupId>1</GroupId> <Id>1</Id> <Name>sample string 2</Name> <PushUtilization>true</PushUtilization> <StatusEmail>sample string 4</StatusEmail> <Suspended>true</Suspended> <Url>sample string 3</Url> </PushSubscriberModel> <PushSubscriberModel> <GroupId>1</GroupId> <Id>1</Id> <Name>sample string 2</Name> <PushUtilization>true</PushUtilization> <StatusEmail>sample string 4</StatusEmail> <Suspended>true</Suspended> <Url>sample string 3</Url> </PushSubscriberModel> </ArrayOfPushSubscriberModel>