GET api/v3/locations/{locationId}/cameraStatus
Return Lyric Camera and RSI Camera status. Equivalent SOAP API : GetCameraStatus
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CameraStatusResults
CameraStatusResults| Name | Description | Type | Additional information |
|---|---|---|---|
| CameraStatus | CameraStatusInfo |
None. |
|
| ResultCode | integer |
None. |
|
| ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"CameraStatus": {
"rsiStatusInfo": [
{
"RSIDeviceID": 1,
"DevcieIndex": 2,
"BatteryStatus": 3,
"SupervisionStatus": 4,
"CoverTamper": 5
},
{
"RSIDeviceID": 1,
"DevcieIndex": 2,
"BatteryStatus": 3,
"SupervisionStatus": 4,
"CoverTamper": 5
}
],
"lyricCameraStatusInfo": [
{
"DeviceID": 1,
"CameraSerialNumber": "sample string 2",
"PrivacyMode": 6,
"OnlineStatus": 7,
"SignalStrength": 8,
"SnapShotURI": "sample string 9",
"SnapShotCreatedDate": "sample string 10",
"LiveSnapShotURI": "sample string 11",
"FirmwareUpgradeStatus": 12,
"RebootRequired": 13
},
{
"DeviceID": 1,
"CameraSerialNumber": "sample string 2",
"PrivacyMode": 6,
"OnlineStatus": 7,
"SignalStrength": 8,
"SnapShotURI": "sample string 9",
"SnapShotCreatedDate": "sample string 10",
"LiveSnapShotURI": "sample string 11",
"FirmwareUpgradeStatus": 12,
"RebootRequired": 13
}
],
"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"
},
{
"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"
}
],
"motionViewerStatusInfo": [
{
"DeviceID": 1,
"CameraSerialNumber": "sample string 2",
"LowBattery": 3,
"Fault": 4,
"SupervisionFailure": 5,
"OnlineStatus": 6,
"Alarm": 7,
"Bypass": 8,
"Trouble": 9,
"Tamper": 10,
"SnapShotURI": "sample string 11",
"SnapShotCreatedDate": "2025-10-28T10:06:20.5969148-04:00",
"MediaId": "sample string 13",
"VoDEnabled": true
},
{
"DeviceID": 1,
"CameraSerialNumber": "sample string 2",
"LowBattery": 3,
"Fault": 4,
"SupervisionFailure": 5,
"OnlineStatus": 6,
"Alarm": 7,
"Bypass": 8,
"Trouble": 9,
"Tamper": 10,
"SnapShotURI": "sample string 11",
"SnapShotCreatedDate": "2025-10-28T10:06:20.5969148-04:00",
"MediaId": "sample string 13",
"VoDEnabled": true
}
]
},
"ResultCode": 1,
"ResultData": "sample string 2"
}
application/xml, text/xml
Sample:
<CameraStatusResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
<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>
<CameraStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.PartnerCamera">
<d2p1:lyricCameraStatusInfo>
<d2p1:LyricCameraStatusInfo>
<d2p1:AccessToken>sample string 3</d2p1:AccessToken>
<d2p1:CameraSerialNumber>sample string 2</d2p1:CameraSerialNumber>
<d2p1:DeviceID>1</d2p1:DeviceID>
<d2p1:FirmwareUpgradeStatus>12</d2p1:FirmwareUpgradeStatus>
<d2p1:LiveSnapShotURI>sample string 11</d2p1:LiveSnapShotURI>
<d2p1:OnlineStatus>7</d2p1:OnlineStatus>
<d2p1:PrivacyMode>6</d2p1:PrivacyMode>
<d2p1:RebootRequired>13</d2p1:RebootRequired>
<d2p1:RefreshToken>sample string 4</d2p1:RefreshToken>
<d2p1:SignalStrength>8</d2p1:SignalStrength>
<d2p1:SnapShotCreatedDate>sample string 10</d2p1:SnapShotCreatedDate>
<d2p1:SnapShotURI>sample string 9</d2p1:SnapShotURI>
<d2p1:TokenExpiryTime>2025-10-28T10:06:20.5929144-04:00</d2p1:TokenExpiryTime>
</d2p1:LyricCameraStatusInfo>
<d2p1:LyricCameraStatusInfo>
<d2p1:AccessToken>sample string 3</d2p1:AccessToken>
<d2p1:CameraSerialNumber>sample string 2</d2p1:CameraSerialNumber>
<d2p1:DeviceID>1</d2p1:DeviceID>
<d2p1:FirmwareUpgradeStatus>12</d2p1:FirmwareUpgradeStatus>
<d2p1:LiveSnapShotURI>sample string 11</d2p1:LiveSnapShotURI>
<d2p1:OnlineStatus>7</d2p1:OnlineStatus>
<d2p1:PrivacyMode>6</d2p1:PrivacyMode>
<d2p1:RebootRequired>13</d2p1:RebootRequired>
<d2p1:RefreshToken>sample string 4</d2p1:RefreshToken>
<d2p1:SignalStrength>8</d2p1:SignalStrength>
<d2p1:SnapShotCreatedDate>sample string 10</d2p1:SnapShotCreatedDate>
<d2p1:SnapShotURI>sample string 9</d2p1:SnapShotURI>
<d2p1:TokenExpiryTime>2025-10-28T10:06:20.5929144-04:00</d2p1:TokenExpiryTime>
</d2p1:LyricCameraStatusInfo>
</d2p1:lyricCameraStatusInfo>
<d2p1:motionViewerStatusInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices">
<d3p1:MotionViewerCameraStatusInfo>
<d3p1:Alarm>7</d3p1:Alarm>
<d3p1:Bypass>8</d3p1:Bypass>
<d3p1:CameraSerialNumber>sample string 2</d3p1:CameraSerialNumber>
<d3p1:DeviceID>1</d3p1:DeviceID>
<d3p1:Fault>4</d3p1:Fault>
<d3p1:LowBattery>3</d3p1:LowBattery>
<d3p1:MediaId>sample string 13</d3p1:MediaId>
<d3p1:OnlineStatus>6</d3p1:OnlineStatus>
<d3p1:SnapShotCreatedDate>2025-10-28T10:06:20.5969148-04:00</d3p1:SnapShotCreatedDate>
<d3p1:SnapShotURI>sample string 11</d3p1:SnapShotURI>
<d3p1:SupervisionFailure>5</d3p1:SupervisionFailure>
<d3p1:Tamper>10</d3p1:Tamper>
<d3p1:Trouble>9</d3p1:Trouble>
<d3p1:VoDEnabled>true</d3p1:VoDEnabled>
</d3p1:MotionViewerCameraStatusInfo>
<d3p1:MotionViewerCameraStatusInfo>
<d3p1:Alarm>7</d3p1:Alarm>
<d3p1:Bypass>8</d3p1:Bypass>
<d3p1:CameraSerialNumber>sample string 2</d3p1:CameraSerialNumber>
<d3p1:DeviceID>1</d3p1:DeviceID>
<d3p1:Fault>4</d3p1:Fault>
<d3p1:LowBattery>3</d3p1:LowBattery>
<d3p1:MediaId>sample string 13</d3p1:MediaId>
<d3p1:OnlineStatus>6</d3p1:OnlineStatus>
<d3p1:SnapShotCreatedDate>2025-10-28T10:06:20.5969148-04:00</d3p1:SnapShotCreatedDate>
<d3p1:SnapShotURI>sample string 11</d3p1:SnapShotURI>
<d3p1:SupervisionFailure>5</d3p1:SupervisionFailure>
<d3p1:Tamper>10</d3p1:Tamper>
<d3p1:Trouble>9</d3p1:Trouble>
<d3p1:VoDEnabled>true</d3p1:VoDEnabled>
</d3p1:MotionViewerCameraStatusInfo>
</d2p1:motionViewerStatusInfo>
<d2p1:rsiStatusInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/TC2Domain.RSIDevice">
<d3p1:RSIDeviceStatus>
<d3p1:BatteryStatus>3</d3p1:BatteryStatus>
<d3p1:CoverTamper>5</d3p1:CoverTamper>
<d3p1:DevcieIndex>2</d3p1:DevcieIndex>
<d3p1:RSIDeviceID>1</d3p1:RSIDeviceID>
<d3p1:SupervisionStatus>4</d3p1:SupervisionStatus>
</d3p1:RSIDeviceStatus>
<d3p1:RSIDeviceStatus>
<d3p1:BatteryStatus>3</d3p1:BatteryStatus>
<d3p1:CoverTamper>5</d3p1:CoverTamper>
<d3p1:DevcieIndex>2</d3p1:DevcieIndex>
<d3p1:RSIDeviceID>1</d3p1:RSIDeviceID>
<d3p1:SupervisionStatus>4</d3p1:SupervisionStatus>
</d3p1:RSIDeviceStatus>
</d2p1:rsiStatusInfo>
<d2p1:wifidoorbellinfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices">
<d3p1:WiFiDoorBellInfo>
<d3p1:AssociationStatus>15</d3p1:AssociationStatus>
<d3p1:DeviceID>1</d3p1:DeviceID>
<d3p1:DeviceModel>2</d3p1:DeviceModel>
<d3p1:DeviceSerialText>sample string 16</d3p1:DeviceSerialText>
<d3p1:DeviceUpdatedAt>18</d3p1:DeviceUpdatedAt>
<d3p1:Gen1PartnerDeviceID>sample string 19</d3p1:Gen1PartnerDeviceID>
<d3p1:IsExistingDoorBellUser>8</d3p1:IsExistingDoorBellUser>
<d3p1:IsMotionEnabled>10</d3p1:IsMotionEnabled>
<d3p1:LEDColorInDevice>sample string 7</d3p1:LEDColorInDevice>
<d3p1:LockID>9</d3p1:LockID>
<d3p1:MigrationStatus>sample string 17</d3p1:MigrationStatus>
<d3p1:PartitionId>14</d3p1:PartitionId>
<d3p1:PartnerDeviceID>sample string 12</d3p1:PartnerDeviceID>
<d3p1:PartnerDeviceName>sample string 13</d3p1:PartnerDeviceName>
<d3p1:SetupErrorID>11</d3p1:SetupErrorID>
<d3p1:SetupStateID>5</d3p1:SetupStateID>
<d3p1:State>sample string 4</d3p1:State>
<d3p1:TimeZoneID>3</d3p1:TimeZoneID>
<d3p1:WiFiName>sample string 6</d3p1:WiFiName>
</d3p1:WiFiDoorBellInfo>
<d3p1:WiFiDoorBellInfo>
<d3p1:AssociationStatus>15</d3p1:AssociationStatus>
<d3p1:DeviceID>1</d3p1:DeviceID>
<d3p1:DeviceModel>2</d3p1:DeviceModel>
<d3p1:DeviceSerialText>sample string 16</d3p1:DeviceSerialText>
<d3p1:DeviceUpdatedAt>18</d3p1:DeviceUpdatedAt>
<d3p1:Gen1PartnerDeviceID>sample string 19</d3p1:Gen1PartnerDeviceID>
<d3p1:IsExistingDoorBellUser>8</d3p1:IsExistingDoorBellUser>
<d3p1:IsMotionEnabled>10</d3p1:IsMotionEnabled>
<d3p1:LEDColorInDevice>sample string 7</d3p1:LEDColorInDevice>
<d3p1:LockID>9</d3p1:LockID>
<d3p1:MigrationStatus>sample string 17</d3p1:MigrationStatus>
<d3p1:PartitionId>14</d3p1:PartitionId>
<d3p1:PartnerDeviceID>sample string 12</d3p1:PartnerDeviceID>
<d3p1:PartnerDeviceName>sample string 13</d3p1:PartnerDeviceName>
<d3p1:SetupErrorID>11</d3p1:SetupErrorID>
<d3p1:SetupStateID>5</d3p1:SetupStateID>
<d3p1:State>sample string 4</d3p1:State>
<d3p1:TimeZoneID>3</d3p1:TimeZoneID>
<d3p1:WiFiName>sample string 6</d3p1:WiFiName>
</d3p1:WiFiDoorBellInfo>
</d2p1:wifidoorbellinfo>
</CameraStatus>
</CameraStatusResults>