POST api/notifications/pushsubscriptions

Create a new push subscription to the specified topic. The subscription can also be used to poll for notifications to allow recovery after downtime on the recieving service.

Required Scopes

System.PushNotifications

Request Information

URI Parameters

None.

Body Parameters

Subscription Details

SubscribeDataWithPush

Name	Description	Type	Additional information
TopicCode		string	None.
Push		PushDetails	None.

{
  "TopicCode": "sample string 1",
  "Push": {
    "URL": "sample string 1",
    "Format": 0,
    "AuthEnabled": true,
    "AuthScheme": "sample string 3",
    "AuthParameter": "sample string 4"
  }
}

<SubscribeDataWithPush xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.WebAPI.Models">
  <Push>
    <AuthEnabled>true</AuthEnabled>
    <AuthParameter>sample string 4</AuthParameter>
    <AuthScheme>sample string 3</AuthScheme>
    <Format>Uninitialised</Format>
    <URL>sample string 1</URL>
  </Push>
  <TopicCode>sample string 1</TopicCode>
</SubscribeDataWithPush>

Response Information

Resource Description

A new subscription ID.

SubscriptionResponse

Name	Description	Type	Additional information
SubscriptionId		globally unique identifier	Required

Response Formats

application/json, text/json
application/xml, text/xml

{
  "SubscriptionId": "3d3f392d-2db4-43c8-a6d1-39e368eeae37"
}

<SubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models.Notification">
  <SubscriptionId>3d3f392d-2db4-43c8-a6d1-39e368eeae37</SubscriptionId>
</SubscriptionResponse>