POST api/Push/ConfigurationSubscribe

Create new PUSH subscription for unit configurations. Only one push configuration subscription per group is allowed.

Request Information

URI Parameters

None.

Body Parameters

PushConfigurationSubscriberModel
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. Must be a valid absolute Http or Https url

string

String length: inclusive between 1 and 256

GroupId

Optional GroupdId. Default value is group id of requesting user

integer32

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Url": "sample string 3",
  "GroupId": 1
}

application/xml, text/xml

Sample:
<PushConfigurationSubscriberModel 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>
  <Url>sample string 3</Url>
</PushConfigurationSubscriberModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Create new PUSH subscription for unit configurations. Only one push configuration 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.