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

Return a Settings for Lyric Camera. Equivalent SOAP API : GetPartnerCameraLiveStream

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

PartnerCameraSettingResults

Name	Type	Additional information
PartnerCameraSettings	PartnerCameraSetting	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PartnerCameraSettings": {
    "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
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

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