POST api/v1/locations/{locationId}/doorbell/updatedoorbell

Update DoorBell details to be called for Doorbell Initial configuration setup and Enrollment of existing skybell user and to update the details of Doorbell details.

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID where Doorbell Device is added	integer	Required

Body Parameters

WifiDoorBell userinfo

WifiInfo

Name	Description	Type	Additional information
wiFiDoorBellInfo		WiFiDoorBellInfo	None.
wiFiDoorBellUserInfo		WiFiDoorBellUserInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "wiFiDoorBellInfo": {
    "DeviceID": 1,
    "DeviceModel": 2,
    "TimeZoneID": 3,
    "State": "sample string 4",
    "SetupStateID": 5,
    "WiFiName": "sample string 6",
    "LEDColorInDevice": "sample string 7",
    "IsExistingDoorBellUser": 8,
    "LockID": 9,
    "IsMotionEnabled": 10,
    "SetupErrorID": 11,
    "PartnerDeviceID": "sample string 12",
    "PartnerDeviceName": "sample string 13",
    "PartitionId": 14,
    "AssociationStatus": 15,
    "DeviceSerialText": "sample string 16",
    "MigrationStatus": "sample string 17",
    "DeviceUpdatedAt": 18,
    "Gen1PartnerDeviceID": "sample string 19"
  },
  "wiFiDoorBellUserInfo": {
    "PartnerUserID": "sample string 1",
    "PartnerUserName": "sample string 2",
    "AccessToken": "sample string 3",
    "RefreshToken": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<WifiInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
  <wiFiDoorBellInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices">
    <d2p1:AssociationStatus>15</d2p1:AssociationStatus>
    <d2p1:DeviceID>1</d2p1:DeviceID>
    <d2p1:DeviceModel>2</d2p1:DeviceModel>
    <d2p1:DeviceSerialText>sample string 16</d2p1:DeviceSerialText>
    <d2p1:DeviceUpdatedAt>18</d2p1:DeviceUpdatedAt>
    <d2p1:Gen1PartnerDeviceID>sample string 19</d2p1:Gen1PartnerDeviceID>
    <d2p1:IsExistingDoorBellUser>8</d2p1:IsExistingDoorBellUser>
    <d2p1:IsMotionEnabled>10</d2p1:IsMotionEnabled>
    <d2p1:LEDColorInDevice>sample string 7</d2p1:LEDColorInDevice>
    <d2p1:LockID>9</d2p1:LockID>
    <d2p1:MigrationStatus>sample string 17</d2p1:MigrationStatus>
    <d2p1:PartitionId>14</d2p1:PartitionId>
    <d2p1:PartnerDeviceID>sample string 12</d2p1:PartnerDeviceID>
    <d2p1:PartnerDeviceName>sample string 13</d2p1:PartnerDeviceName>
    <d2p1:SetupErrorID>11</d2p1:SetupErrorID>
    <d2p1:SetupStateID>5</d2p1:SetupStateID>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:TimeZoneID>3</d2p1:TimeZoneID>
    <d2p1:WiFiName>sample string 6</d2p1:WiFiName>
  </wiFiDoorBellInfo>
  <wiFiDoorBellUserInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices">
    <d2p1:AccessToken>sample string 3</d2p1:AccessToken>
    <d2p1:PartnerUserID>sample string 1</d2p1:PartnerUserID>
    <d2p1:PartnerUserName>sample string 2</d2p1:PartnerUserName>
    <d2p1:RefreshToken>sample string 4</d2p1:RefreshToken>
  </wiFiDoorBellUserInfo>
</WifiInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UpdateDoorbellDetailResult

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

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<UpdateDoorbellDetailResult 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">2</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
  <SetupStateID>1</SetupStateID>
</UpdateDoorbellDetailResult>