Help Page Home

POST api/notifications/subscriptions

Create a new subscription to the specified topic.

Required Scopes

System.Notifications

Request Information

URI Parameters

None.

Body Parameters

Subscription Details

SubscribeData
NameDescriptionTypeAdditional information
TopicCode

string

None.

Request Formats

{
  "TopicCode": "sample string 1"
}
<SubscribeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.WebAPI.MicroservicesDTO.Notifications">
  <TopicCode>sample string 1</TopicCode>
</SubscribeData>

Response Information

Resource Description

A new subscription ID.

SubscriptionResponse
NameDescriptionTypeAdditional information
SubscriptionId

globally unique identifier

Required

Response Formats

{
  "SubscriptionId": "38a76489-fae1-4fbd-9cc3-327c4ee29149"
}
<SubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models.Notification">
  <SubscriptionId>38a76489-fae1-4fbd-9cc3-327c4ee29149</SubscriptionId>
</SubscriptionResponse>