GET api/v1/locations/{locationId}/doorbell/doorbellSettings/partner/{partnerDeviceId}

This api get the WifiDoorBell Settings and Name

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required
partnerDeviceId		string	Required

Body Parameters

None.

Response Information

Resource Description

GetDoorBellSettingsResult

Name	Type	Additional information
wiFiDoorBellSettings	WiFiDoorBellSettings	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "wiFiDoorBellSettings": {
    "RingTone": "sample string 1",
    "DoNotRing": "sample string 2",
    "IndoorChime": "sample string 3",
    "DigitalDoorbell": "sample string 4",
    "VideoProfile": "sample string 5",
    "MicrophoneVolume": "sample string 6",
    "SpeakerVolume": "sample string 7",
    "ChimeLevel": "sample string 8",
    "MotionSensitivity": "sample string 9",
    "LowLightThreshold": "sample string 10",
    "MediumLightThreshold": "sample string 11",
    "HighLightThreshold": "sample string 12",
    "LowDACBrightness": "sample string 13",
    "MediumDACBrightness": "sample string 14",
    "HighDACBrightness": "sample string 15",
    "RGBRedValue": "sample string 16",
    "RGBGreenValue": "sample string 17",
    "RGBBlueValue": "sample string 18",
    "FrontLEDBrightness": "sample string 19",
    "MotionPolicy": "sample string 20",
    "PartnerDeviceName": "sample string 21",
    "PartitionId": 22
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<GetDoorBellSettingsResult 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>
  <wiFiDoorBellSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices">
    <d2p1:ChimeLevel>sample string 8</d2p1:ChimeLevel>
    <d2p1:DigitalDoorbell>sample string 4</d2p1:DigitalDoorbell>
    <d2p1:DoNotRing>sample string 2</d2p1:DoNotRing>
    <d2p1:FrontLEDBrightness>sample string 19</d2p1:FrontLEDBrightness>
    <d2p1:HighDACBrightness>sample string 15</d2p1:HighDACBrightness>
    <d2p1:HighLightThreshold>sample string 12</d2p1:HighLightThreshold>
    <d2p1:IndoorChime>sample string 3</d2p1:IndoorChime>
    <d2p1:LowDACBrightness>sample string 13</d2p1:LowDACBrightness>
    <d2p1:LowLightThreshold>sample string 10</d2p1:LowLightThreshold>
    <d2p1:MediumDACBrightness>sample string 14</d2p1:MediumDACBrightness>
    <d2p1:MediumLightThreshold>sample string 11</d2p1:MediumLightThreshold>
    <d2p1:MicrophoneVolume>sample string 6</d2p1:MicrophoneVolume>
    <d2p1:MotionPolicy>sample string 20</d2p1:MotionPolicy>
    <d2p1:MotionSensitivity>sample string 9</d2p1:MotionSensitivity>
    <d2p1:PartitionId>22</d2p1:PartitionId>
    <d2p1:PartnerDeviceName>sample string 21</d2p1:PartnerDeviceName>
    <d2p1:RGBBlueValue>sample string 18</d2p1:RGBBlueValue>
    <d2p1:RGBGreenValue>sample string 17</d2p1:RGBGreenValue>
    <d2p1:RGBRedValue>sample string 16</d2p1:RGBRedValue>
    <d2p1:RingTone>sample string 1</d2p1:RingTone>
    <d2p1:SpeakerVolume>sample string 7</d2p1:SpeakerVolume>
    <d2p1:VideoProfile>sample string 5</d2p1:VideoProfile>
  </wiFiDoorBellSettings>
</GetDoorBellSettingsResult>