POST api/v1/locations/{locationId}/devices/{deviceId}/subscribe

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required
deviceId		integer	Required

Body Parameters

Subscriber

Name	Type	Additional information
ExternalPartnerId	integer	None.
SubscriberPartnerId	string	None.
SubscriberName	string	None.
WebhookURL	string	None.
AdditionalInfo	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ExternalPartnerId": 1,
  "SubscriberPartnerId": "sample string 2",
  "SubscriberName": "sample string 3",
  "WebhookURL": "sample string 4",
  "AdditionalInfo": "sample string 5"
}

application/xml, text/xml

Sample:

<Subscriber xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
  <AdditionalInfo>sample string 5</AdditionalInfo>
  <ExternalPartnerId>1</ExternalPartnerId>
  <SubscriberName>sample string 3</SubscriberName>
  <SubscriberPartnerId>sample string 2</SubscriberPartnerId>
  <WebhookURL>sample string 4</WebhookURL>
</Subscriber>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResults

Name	Description	Type	Additional information
ResultCode		integer	None.
ResultData		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<BaseResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">
  <ResultCode>1</ResultCode>
  <ResultData>sample string 2</ResultData>
</BaseResults>