POST api/v1/locations/{LocationId}/doorbell/doorbellsettings/partner/{partnerDeviceId}
Updates the DoorBell settings to Skybell and Device Name to TC DB
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
LocationId | integer |
Required |
|
partnerDeviceId | string |
Required |
Body Parameters
WiFiDoorBellSettingsName | Description | Type | Additional information |
---|---|---|---|
RingTone | string |
None. |
|
DoNotRing | string |
None. |
|
IndoorChime | string |
None. |
|
DigitalDoorbell | string |
None. |
|
VideoProfile | string |
None. |
|
MicrophoneVolume | string |
None. |
|
SpeakerVolume | string |
None. |
|
ChimeLevel | string |
None. |
|
MotionSensitivity | string |
None. |
|
LowLightThreshold | string |
None. |
|
MediumLightThreshold | string |
None. |
|
HighLightThreshold | string |
None. |
|
LowDACBrightness | string |
None. |
|
MediumDACBrightness | string |
None. |
|
HighDACBrightness | string |
None. |
|
RGBRedValue | string |
None. |
|
RGBGreenValue | string |
None. |
|
RGBBlueValue | string |
None. |
|
FrontLEDBrightness | string |
None. |
|
MotionPolicy | string |
None. |
|
PartnerDeviceName | string |
None. |
|
PartitionId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "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 }
application/xml, text/xml
Sample:
<WiFiDoorBellSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Devices"> <ChimeLevel>sample string 8</ChimeLevel> <DigitalDoorbell>sample string 4</DigitalDoorbell> <DoNotRing>sample string 2</DoNotRing> <FrontLEDBrightness>sample string 19</FrontLEDBrightness> <HighDACBrightness>sample string 15</HighDACBrightness> <HighLightThreshold>sample string 12</HighLightThreshold> <IndoorChime>sample string 3</IndoorChime> <LowDACBrightness>sample string 13</LowDACBrightness> <LowLightThreshold>sample string 10</LowLightThreshold> <MediumDACBrightness>sample string 14</MediumDACBrightness> <MediumLightThreshold>sample string 11</MediumLightThreshold> <MicrophoneVolume>sample string 6</MicrophoneVolume> <MotionPolicy>sample string 20</MotionPolicy> <MotionSensitivity>sample string 9</MotionSensitivity> <PartitionId>22</PartitionId> <PartnerDeviceName>sample string 21</PartnerDeviceName> <RGBBlueValue>sample string 18</RGBBlueValue> <RGBGreenValue>sample string 17</RGBGreenValue> <RGBRedValue>sample string 16</RGBRedValue> <RingTone>sample string 1</RingTone> <SpeakerVolume>sample string 7</SpeakerVolume> <VideoProfile>sample string 5</VideoProfile> </WiFiDoorBellSettings>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BaseResults
BaseResultsName | 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>