POST api/Push/Post

Create new PUSH subscription. Only one push subscription per group is allowed.

Request Information

URI Parameters

None.

Body Parameters

PushSubscriberModel
NameDescriptionTypeAdditional 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.

Request 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
}

application/xml, text/xml

Sample:
<PushSubscriberModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Create new PUSH subscription. Only one push subscription per group is allowed.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.