PUT api/v1/locations/{locationId}/partner/{partnerId}/{partnerCameraSerialNumber}/CameraSettings

Save the Settings for Lyric Camera. Equivalent SOAP API : SavePartnerCameraSettings

Request Information

URI Parameters

Name	Type	Additional information
partnerId	integer	Required
locationId	integer	Required
partnerCameraSerialNumber	string	Required

Body Parameters

PartnerCameraSetting

Name	Type	Additional information
AudioDetection	integer	None.
AudioSensitivity	integer	None.
LedStatus	integer	None.
MicStatus	integer	None.
MotionAarea	Collection of MotionArea	None.
MotionDetection	integer	None.
MotionZone	integer	None.
NightMode	integer	None.
PrivacyMode	integer	None.
RecordingAhead	integer	None.
SpeakerStatus	integer	None.
StoragePlan	integer	None.
Timezone	string	None.
Version	string	None.
IPAddress	string	None.
MaxResolution	string	None.
FirmwareVersion	string	None.
FirmwareLastUpdated	string	None.
CameraName	string	None.
MaxMotionAreas	integer	None.
CameraSerialNumber	string	None.
CameraType	string	None.
SignalStrength	integer	None.
Dst	integer	None.
VAVEnabled	integer	None.
VideoQuality	integer	None.
SecurityPanelStatus	integer	None.
PartitionId	integer	None.
AssociationStatus	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AudioDetection": 1,
  "AudioSensitivity": 2,
  "LedStatus": 3,
  "MicStatus": 4,
  "MotionAarea": [
    {
      "height": 1,
      "sensitivity": 2,
      "shape": "sample string 3",
      "start_x": 4,
      "start_y": 5,
      "width": 6
    },
    {
      "height": 1,
      "sensitivity": 2,
      "shape": "sample string 3",
      "start_x": 4,
      "start_y": 5,
      "width": 6
    }
  ],
  "MotionDetection": 5,
  "MotionZone": 6,
  "NightMode": 7,
  "PrivacyMode": 8,
  "RecordingAhead": 9,
  "SpeakerStatus": 10,
  "StoragePlan": 11,
  "Timezone": "sample string 12",
  "Version": "sample string 13",
  "IPAddress": "sample string 14",
  "MaxResolution": "sample string 15",
  "FirmwareVersion": "sample string 16",
  "FirmwareLastUpdated": "sample string 17",
  "CameraName": "sample string 18",
  "MaxMotionAreas": 19,
  "CameraSerialNumber": "sample string 20",
  "CameraType": "sample string 21",
  "SignalStrength": 22,
  "Dst": 23,
  "VAVEnabled": 24,
  "CameraMAC": "sample string 25",
  "VideoQuality": 26,
  "SecurityPanelStatus": 27,
  "PartitionId": 1,
  "AssociationStatus": 28
}

application/xml, text/xml

Sample:

<PartnerCameraSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.PartnerCamera">
  <AssociationStatus>28</AssociationStatus>
  <AudioDetection>1</AudioDetection>
  <AudioSensitivity>2</AudioSensitivity>
  <CameraMAC>sample string 25</CameraMAC>
  <CameraName>sample string 18</CameraName>
  <CameraSerialNumber>sample string 20</CameraSerialNumber>
  <CameraType>sample string 21</CameraType>
  <Dst>23</Dst>
  <FirmwareLastUpdated>sample string 17</FirmwareLastUpdated>
  <FirmwareVersion>sample string 16</FirmwareVersion>
  <IPAddress>sample string 14</IPAddress>
  <LedStatus>3</LedStatus>
  <MaxMotionAreas>19</MaxMotionAreas>
  <MaxResolution>sample string 15</MaxResolution>
  <MicStatus>4</MicStatus>
  <MotionAarea>
    <MotionArea>
      <height>1</height>
      <sensitivity>2</sensitivity>
      <shape>sample string 3</shape>
      <start_x>4</start_x>
      <start_y>5</start_y>
      <width>6</width>
    </MotionArea>
    <MotionArea>
      <height>1</height>
      <sensitivity>2</sensitivity>
      <shape>sample string 3</shape>
      <start_x>4</start_x>
      <start_y>5</start_y>
      <width>6</width>
    </MotionArea>
  </MotionAarea>
  <MotionDetection>5</MotionDetection>
  <MotionZone>6</MotionZone>
  <NightMode>7</NightMode>
  <PartitionId>1</PartitionId>
  <PrivacyMode>8</PrivacyMode>
  <RecordingAhead>9</RecordingAhead>
  <SecurityPanelStatus>27</SecurityPanelStatus>
  <SignalStrength>22</SignalStrength>
  <SpeakerStatus>10</SpeakerStatus>
  <StoragePlan>11</StoragePlan>
  <Timezone>sample string 12</Timezone>
  <VAVEnabled>24</VAVEnabled>
  <Version>sample string 13</Version>
  <VideoQuality>26</VideoQuality>
</PartnerCameraSetting>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResults

Name	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>