GET api/v1/locations/{locationId}/camera/{partnerId}/{deviceId}/ConfigurationDetails/{configuration}

Get Camera Configuration Details

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

TC2 Location ID

integer

Required

partnerId

Partner ID

integer

Required

deviceId

Camera deviceID

integer

Required

configuration

Configuration type

string

Required

Body Parameters

None.

Response Information

Resource Description

GetCameraConfigurationResults

GetCameraConfigurationResults
NameDescriptionTypeAdditional information
GetRoot

RootObject

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "GetRoot": {
    "deviceConfig": {
      "deviceId": "sample string 1",
      "deviceType": "sample string 2",
      "serialNumber": "sample string 3",
      "manufacturerName": "sample string 4",
      "manufacturerDate": "sample string 5"
    },
    "networkConfig": {
      "dhcp": "sample string 1",
      "wireless": {
        "ssid": "sample string 1",
        "security": "sample string 2",
        "password": "sample string 3"
      }
    },
    "systemConfig": {
      "name": "sample string 1",
      "timezone": "sample string 2",
      "statusLed": "sample string 3",
      "partitionId": 4,
      "zone": 5
    },
    "audioConfig": {
      "micState": "sample string 1",
      "audioInput": 2,
      "audioOutput": 3
    },
    "detectionConfig": {
      "motionDetection": "sample string 1",
      "humanDetection": "sample string 2",
      "audioDetection": "sample string 3",
      "faceDetection": "sample string 4"
    },
    "videoConfig": {
      "privacyMode": "sample string 1",
      "videoQualityPreference": "sample string 2",
      "nightMode": "sample string 3",
      "brightness": 4,
      "wdr": "sample string 5",
      "horizontalFlip": "sample string 6",
      "VeritcalFlip": "sample string 7",
      "timeOverlay": "sample string 8"
    },
    "eventAlert": {
      "humanDetection": "sample string 1",
      "abnormalSound": "sample string 2",
      "bellEvent": "sample string 3",
      "faceEvent": "sample string 4"
    },
    "motionArea": [
      {
        "Name": "sample string 1",
        "Enabled": "sample string 2",
        "Height": 3,
        "Width": 4,
        "StartX": 5,
        "StartY": 6,
        "Sensitivity": 7
      },
      {
        "Name": "sample string 1",
        "Enabled": "sample string 2",
        "Height": 3,
        "Width": 4,
        "StartX": 5,
        "StartY": 6,
        "Sensitivity": 7
      }
    ]
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:
<GetCameraConfigurationResults 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">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <GetRoot xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Devices.HoneywellHomeVideoDoorBell">
    <d2p1:audioConfig>
      <d2p1:audioInput>2</d2p1:audioInput>
      <d2p1:audioOutput>3</d2p1:audioOutput>
      <d2p1:micState>sample string 1</d2p1:micState>
    </d2p1:audioConfig>
    <d2p1:detectionConfig>
      <d2p1:audioDetection>sample string 3</d2p1:audioDetection>
      <d2p1:faceDetection>sample string 4</d2p1:faceDetection>
      <d2p1:humanDetection>sample string 2</d2p1:humanDetection>
      <d2p1:motionDetection>sample string 1</d2p1:motionDetection>
    </d2p1:detectionConfig>
    <d2p1:deviceConfig>
      <d2p1:deviceId>sample string 1</d2p1:deviceId>
      <d2p1:deviceType>sample string 2</d2p1:deviceType>
      <d2p1:manufacturerDate>sample string 5</d2p1:manufacturerDate>
      <d2p1:manufacturerName>sample string 4</d2p1:manufacturerName>
      <d2p1:serialNumber>sample string 3</d2p1:serialNumber>
    </d2p1:deviceConfig>
    <d2p1:eventAlert>
      <d2p1:abnormalSound>sample string 2</d2p1:abnormalSound>
      <d2p1:bellEvent>sample string 3</d2p1:bellEvent>
      <d2p1:faceEvent>sample string 4</d2p1:faceEvent>
      <d2p1:humanDetection>sample string 1</d2p1:humanDetection>
    </d2p1:eventAlert>
    <d2p1:motionArea>
      <d2p1:MotionAreaConfig>
        <d2p1:Enabled>sample string 2</d2p1:Enabled>
        <d2p1:Height>3</d2p1:Height>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:Sensitivity>7</d2p1:Sensitivity>
        <d2p1:StartX>5</d2p1:StartX>
        <d2p1:StartY>6</d2p1:StartY>
        <d2p1:Width>4</d2p1:Width>
      </d2p1:MotionAreaConfig>
      <d2p1:MotionAreaConfig>
        <d2p1:Enabled>sample string 2</d2p1:Enabled>
        <d2p1:Height>3</d2p1:Height>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:Sensitivity>7</d2p1:Sensitivity>
        <d2p1:StartX>5</d2p1:StartX>
        <d2p1:StartY>6</d2p1:StartY>
        <d2p1:Width>4</d2p1:Width>
      </d2p1:MotionAreaConfig>
    </d2p1:motionArea>
    <d2p1:networkConfig>
      <d2p1:dhcp>sample string 1</d2p1:dhcp>
      <d2p1:wireless>
        <d2p1:password>sample string 3</d2p1:password>
        <d2p1:security>sample string 2</d2p1:security>
        <d2p1:ssid>sample string 1</d2p1:ssid>
      </d2p1:wireless>
    </d2p1:networkConfig>
    <d2p1:systemConfig>
      <d2p1:name>sample string 1</d2p1:name>
      <d2p1:partitionId>4</d2p1:partitionId>
      <d2p1:statusLed>sample string 3</d2p1:statusLed>
      <d2p1:timezone>sample string 2</d2p1:timezone>
      <d2p1:zone>5</d2p1:zone>
    </d2p1:systemConfig>
    <d2p1:videoConfig>
      <d2p1:VeritcalFlip>sample string 7</d2p1:VeritcalFlip>
      <d2p1:brightness>4</d2p1:brightness>
      <d2p1:horizontalFlip>sample string 6</d2p1:horizontalFlip>
      <d2p1:nightMode>sample string 3</d2p1:nightMode>
      <d2p1:privacyMode>sample string 1</d2p1:privacyMode>
      <d2p1:timeOverlay>sample string 8</d2p1:timeOverlay>
      <d2p1:videoQualityPreference>sample string 2</d2p1:videoQualityPreference>
      <d2p1:wdr>sample string 5</d2p1:wdr>
    </d2p1:videoConfig>
  </GetRoot>
</GetCameraConfigurationResults>