GET api/v1/locations/{locationId}/devices/{deviceId}/subscribe
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationId | integer |
Required |
|
| deviceId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
SubscribersResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Subscribers |
None. |
Response Formats
application/json, text/json
Sample:
{
"Subscribers": [
{
"ExternalPartnerId": 1,
"SubscriberPartnerId": "sample string 2",
"SubscriberName": "sample string 3",
"WebhookURL": "sample string 4",
"AdditionalInfo": "sample string 5"
},
{
"ExternalPartnerId": 1,
"SubscriberPartnerId": "sample string 2",
"SubscriberName": "sample string 3",
"WebhookURL": "sample string 4",
"AdditionalInfo": "sample string 5"
}
],
"ResultCode": 1,
"ResultData": "sample string 2"
}
application/xml, text/xml
Sample:
<SubscribersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
<ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
<ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
<Subscribers xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.TCExternalPartner">
<d2p1:Subscriber>
<d2p1:AdditionalInfo>sample string 5</d2p1:AdditionalInfo>
<d2p1:ExternalPartnerId>1</d2p1:ExternalPartnerId>
<d2p1:SubscriberName>sample string 3</d2p1:SubscriberName>
<d2p1:SubscriberPartnerId>sample string 2</d2p1:SubscriberPartnerId>
<d2p1:WebhookURL>sample string 4</d2p1:WebhookURL>
</d2p1:Subscriber>
<d2p1:Subscriber>
<d2p1:AdditionalInfo>sample string 5</d2p1:AdditionalInfo>
<d2p1:ExternalPartnerId>1</d2p1:ExternalPartnerId>
<d2p1:SubscriberName>sample string 3</d2p1:SubscriberName>
<d2p1:SubscriberPartnerId>sample string 2</d2p1:SubscriberPartnerId>
<d2p1:WebhookURL>sample string 4</d2p1:WebhookURL>
</d2p1:Subscriber>
</Subscribers>
</SubscribersResult>