GET api/AlarmPush/GetAlarmPushSubscription?id={id}

Get an alarm push subscription.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Subscription Id.

integer32

Required

Body Parameters

None.

Response Information

Resource Description

Get an alarm push subscription.

UserAlarmPushSubscriptionModel
NameDescriptionTypeAdditional information
Id

Subscription id used in the API. (Read-Only)

integer32

None.

Enabled

If the push subscription is enabled. (Required)

boolean

Required

Null values possible.

MethodDestination

The destination for the push-data to be send via chosen method. (Required)

string

Required

Method

The method for the push-data to be send with. (Required)

integer32

Required

Null values possible.

Suspended

Suspension status for the subscription. (Read-only)

boolean

Null values possible.

StatusEmail

Email to alert, for instance on suspension. (Optional)

string

Null values possible.

Name

Name for subscription. (Optional)

string

Null values possible.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Enabled": true,
  "MethodDestination": "sample string 2",
  "Method": 1,
  "Suspended": true,
  "StatusEmail": "sample string 3",
  "Name": "sample string 4"
}

application/xml, text/xml

Sample:
<UserAlarmPushSubscriptionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <Enabled>true</Enabled>
  <Id>1</Id>
  <Method>1</Method>
  <MethodDestination>sample string 2</MethodDestination>
  <Name>sample string 4</Name>
  <StatusEmail>sample string 3</StatusEmail>
  <Suspended>true</Suspended>
</UserAlarmPushSubscriptionModel>