GET api/v1/locations/{locationId}/doorbell/doorbellDetails?deviceId={deviceId}&partitionId={partitionId}

This API provides the WiFi Door Bell details.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

integer

Required
deviceId

integer

Default value is 0
partitionId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

WiFiDoorBellInfo object and Result Code

WiFiDoorBellListInfoResult
NameDescriptionTypeAdditional information
GetWiFiDoorBellResult

Collection of GetWiFiDoorBellResult

None.
ResultCode

integer

None.
ResultData

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "GetWiFiDoorBellResult": [
    {
      "WiFiStrength": 1,
      "PushNotificationFlag": 2,
      "IsOffline": 3,
      "CreatedAt": "2025-04-02T00:01:23.941367-04:00",
      "UpdatedAt": "2025-04-02T00:01:23.941367-04:00",
      "PartnerDeviceName": "sample string 6",
      "Avatar": {
        "Bucket": "sample string 1",
        "Region": "sample string 2",
        "Key": "sample string 3",
        "CreatedAt": "sample string 4",
        "URL": "sample string 5"
      },
      "FirmwareVersion": "sample string 8",
      "DeviceSerialNumber": "sample string 9",
      "IsSRTPEnabled": true,
      "NeedToGetStatus": true,
      "DeviceID": 12,
      "DeviceModel": 13,
      "TimeZoneID": 14,
      "State": "sample string 15",
      "SetupStateID": 16,
      "WiFiName": "sample string 17",
      "LEDColorInDevice": "sample string 18",
      "IsExistingDoorBellUser": 19,
      "LockID": 20,
      "IsMotionEnabled": 21,
      "SetupErrorID": 22,
      "PartnerDeviceID": "sample string 23",
      "PartitionId": 24,
      "AssociationStatus": 25,
      "DeviceSerialText": "sample string 26",
      "MigrationStatus": "sample string 27",
      "DeviceUpdatedAt": 28,
      "Gen1PartnerDeviceID": "sample string 29"
    },
    {
      "WiFiStrength": 1,
      "PushNotificationFlag": 2,
      "IsOffline": 3,
      "CreatedAt": "2025-04-02T00:01:23.941367-04:00",
      "UpdatedAt": "2025-04-02T00:01:23.941367-04:00",
      "PartnerDeviceName": "sample string 6",
      "Avatar": {
        "Bucket": "sample string 1",
        "Region": "sample string 2",
        "Key": "sample string 3",
        "CreatedAt": "sample string 4",
        "URL": "sample string 5"
      },
      "FirmwareVersion": "sample string 8",
      "DeviceSerialNumber": "sample string 9",
      "IsSRTPEnabled": true,
      "NeedToGetStatus": true,
      "DeviceID": 12,
      "DeviceModel": 13,
      "TimeZoneID": 14,
      "State": "sample string 15",
      "SetupStateID": 16,
      "WiFiName": "sample string 17",
      "LEDColorInDevice": "sample string 18",
      "IsExistingDoorBellUser": 19,
      "LockID": 20,
      "IsMotionEnabled": 21,
      "SetupErrorID": 22,
      "PartnerDeviceID": "sample string 23",
      "PartitionId": 24,
      "AssociationStatus": 25,
      "DeviceSerialText": "sample string 26",
      "MigrationStatus": "sample string 27",
      "DeviceUpdatedAt": 28,
      "Gen1PartnerDeviceID": "sample string 29"
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample: 
<WiFiDoorBellListInfoResult 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>
  <GetWiFiDoorBellResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices">
    <d2p1:GetWiFiDoorBellResult>
      <d2p1:AssociationStatus>25</d2p1:AssociationStatus>
      <d2p1:DeviceID>12</d2p1:DeviceID>
      <d2p1:DeviceModel>13</d2p1:DeviceModel>
      <d2p1:DeviceSerialText>sample string 26</d2p1:DeviceSerialText>
      <d2p1:DeviceUpdatedAt>28</d2p1:DeviceUpdatedAt>
      <d2p1:Gen1PartnerDeviceID>sample string 29</d2p1:Gen1PartnerDeviceID>
      <d2p1:IsExistingDoorBellUser>19</d2p1:IsExistingDoorBellUser>
      <d2p1:IsMotionEnabled>21</d2p1:IsMotionEnabled>
      <d2p1:LEDColorInDevice>sample string 18</d2p1:LEDColorInDevice>
      <d2p1:LockID>20</d2p1:LockID>
      <d2p1:MigrationStatus>sample string 27</d2p1:MigrationStatus>
      <d2p1:PartitionId>24</d2p1:PartitionId>
      <d2p1:PartnerDeviceID>sample string 23</d2p1:PartnerDeviceID>
      <d2p1:PartnerDeviceName i:nil="true" />
      <d2p1:SetupErrorID>22</d2p1:SetupErrorID>
      <d2p1:SetupStateID>16</d2p1:SetupStateID>
      <d2p1:State>sample string 15</d2p1:State>
      <d2p1:TimeZoneID>14</d2p1:TimeZoneID>
      <d2p1:WiFiName>sample string 17</d2p1:WiFiName>
      <d2p1:Avatar>
        <d2p1:Bucket>sample string 1</d2p1:Bucket>
        <d2p1:CreatedAt>sample string 4</d2p1:CreatedAt>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Region>sample string 2</d2p1:Region>
        <d2p1:URL>sample string 5</d2p1:URL>
      </d2p1:Avatar>
      <d2p1:CreatedAt>2025-04-02T00:01:23.941367-04:00</d2p1:CreatedAt>
      <d2p1:DeviceSerialNumber>sample string 9</d2p1:DeviceSerialNumber>
      <d2p1:FirmwareVersion>sample string 8</d2p1:FirmwareVersion>
      <d2p1:IsOffline>3</d2p1:IsOffline>
      <d2p1:IsSRTPEnabled>true</d2p1:IsSRTPEnabled>
      <d2p1:NeedToGetStatus>true</d2p1:NeedToGetStatus>
      <d2p1:PartnerDeviceName>sample string 6</d2p1:PartnerDeviceName>
      <d2p1:PartnerDeviceType>sample string 7</d2p1:PartnerDeviceType>
      <d2p1:PushNotificationFlag>2</d2p1:PushNotificationFlag>
      <d2p1:UpdatedAt>2025-04-02T00:01:23.941367-04:00</d2p1:UpdatedAt>
      <d2p1:WiFiStrength>1</d2p1:WiFiStrength>
    </d2p1:GetWiFiDoorBellResult>
    <d2p1:GetWiFiDoorBellResult>
      <d2p1:AssociationStatus>25</d2p1:AssociationStatus>
      <d2p1:DeviceID>12</d2p1:DeviceID>
      <d2p1:DeviceModel>13</d2p1:DeviceModel>
      <d2p1:DeviceSerialText>sample string 26</d2p1:DeviceSerialText>
      <d2p1:DeviceUpdatedAt>28</d2p1:DeviceUpdatedAt>
      <d2p1:Gen1PartnerDeviceID>sample string 29</d2p1:Gen1PartnerDeviceID>
      <d2p1:IsExistingDoorBellUser>19</d2p1:IsExistingDoorBellUser>
      <d2p1:IsMotionEnabled>21</d2p1:IsMotionEnabled>
      <d2p1:LEDColorInDevice>sample string 18</d2p1:LEDColorInDevice>
      <d2p1:LockID>20</d2p1:LockID>
      <d2p1:MigrationStatus>sample string 27</d2p1:MigrationStatus>
      <d2p1:PartitionId>24</d2p1:PartitionId>
      <d2p1:PartnerDeviceID>sample string 23</d2p1:PartnerDeviceID>
      <d2p1:PartnerDeviceName i:nil="true" />
      <d2p1:SetupErrorID>22</d2p1:SetupErrorID>
      <d2p1:SetupStateID>16</d2p1:SetupStateID>
      <d2p1:State>sample string 15</d2p1:State>
      <d2p1:TimeZoneID>14</d2p1:TimeZoneID>
      <d2p1:WiFiName>sample string 17</d2p1:WiFiName>
      <d2p1:Avatar>
        <d2p1:Bucket>sample string 1</d2p1:Bucket>
        <d2p1:CreatedAt>sample string 4</d2p1:CreatedAt>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Region>sample string 2</d2p1:Region>
        <d2p1:URL>sample string 5</d2p1:URL>
      </d2p1:Avatar>
      <d2p1:CreatedAt>2025-04-02T00:01:23.941367-04:00</d2p1:CreatedAt>
      <d2p1:DeviceSerialNumber>sample string 9</d2p1:DeviceSerialNumber>
      <d2p1:FirmwareVersion>sample string 8</d2p1:FirmwareVersion>
      <d2p1:IsOffline>3</d2p1:IsOffline>
      <d2p1:IsSRTPEnabled>true</d2p1:IsSRTPEnabled>
      <d2p1:NeedToGetStatus>true</d2p1:NeedToGetStatus>
      <d2p1:PartnerDeviceName>sample string 6</d2p1:PartnerDeviceName>
      <d2p1:PartnerDeviceType>sample string 7</d2p1:PartnerDeviceType>
      <d2p1:PushNotificationFlag>2</d2p1:PushNotificationFlag>
      <d2p1:UpdatedAt>2025-04-02T00:01:23.941367-04:00</d2p1:UpdatedAt>
      <d2p1:WiFiStrength>1</d2p1:WiFiStrength>
    </d2p1:GetWiFiDoorBellResult>
  </GetWiFiDoorBellResult>
</WiFiDoorBellListInfoResult>