GET api/v1/locations/{locationId}/doorbell/associatedDevice?partitionId={partitionId}

This api provides the list of skybell devices along with configuration status in TC

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

integer

Required

partitionId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

GetAssociatedSkybellDevicesResult

GetAssociatedSkybellDevicesResult
NameDescriptionTypeAdditional information
doorbellDeviceList

Collection of WiFiDoorBellConfigInfo

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "doorbellDeviceList": [
    {
      "PartnerDeviceID": "sample string 1",
      "PartnerDeviceName": "sample string 2",
      "DoorBellConfigState": 3,
      "PartitionId": 4
    },
    {
      "PartnerDeviceID": "sample string 1",
      "PartnerDeviceName": "sample string 2",
      "DoorBellConfigState": 3,
      "PartitionId": 4
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:
<GetAssociatedSkybellDevicesResult 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>
  <doorbellDeviceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices">
    <d2p1:WiFiDoorBellConfigInfo>
      <d2p1:DoorBellConfigState>3</d2p1:DoorBellConfigState>
      <d2p1:PartitionId>4</d2p1:PartitionId>
      <d2p1:PartnerDeviceID>sample string 1</d2p1:PartnerDeviceID>
      <d2p1:PartnerDeviceName>sample string 2</d2p1:PartnerDeviceName>
    </d2p1:WiFiDoorBellConfigInfo>
    <d2p1:WiFiDoorBellConfigInfo>
      <d2p1:DoorBellConfigState>3</d2p1:DoorBellConfigState>
      <d2p1:PartitionId>4</d2p1:PartitionId>
      <d2p1:PartnerDeviceID>sample string 1</d2p1:PartnerDeviceID>
      <d2p1:PartnerDeviceName>sample string 2</d2p1:PartnerDeviceName>
    </d2p1:WiFiDoorBellConfigInfo>
  </doorbellDeviceList>
</GetAssociatedSkybellDevicesResult>