svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

GetPartnerCameraSettings

Return a Settings for Lyric Camera.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
SessionId:
PartnerId:
LocationId:
partnerCameraSerialNumber:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.alarmnet.com/TC2/GetPartnerCameraSettings"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPartnerCameraSettings xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <PartnerId>int</PartnerId>
      <LocationId>long</LocationId>
      <partnerCameraSerialNumber>string</partnerCameraSerialNumber>
    </GetPartnerCameraSettings>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPartnerCameraSettingsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetPartnerCameraSettingsResult>
        <PartnerCameraSettings>
          <AudioDetection>short</AudioDetection>
          <AudioSensitivity>int</AudioSensitivity>
          <LedStatus>short</LedStatus>
          <MicStatus>short</MicStatus>
          <MotionAarea>
            <MotionArea xsi:nil="true" />
            <MotionArea xsi:nil="true" />
          </MotionAarea>
          <MotionDetection>short</MotionDetection>
          <MotionZone>short</MotionZone>
          <NightMode>short</NightMode>
          <PrivacyMode>short</PrivacyMode>
          <RecordingAhead>int</RecordingAhead>
          <SpeakerStatus>short</SpeakerStatus>
          <StoragePlan>short</StoragePlan>
          <Timezone>string</Timezone>
          <Version>string</Version>
          <IPAddress>string</IPAddress>
          <MaxResolution>string</MaxResolution>
          <FirmwareVersion>string</FirmwareVersion>
          <FirmwareLastUpdated>string</FirmwareLastUpdated>
          <CameraName>string</CameraName>
          <MaxMotionAreas>int</MaxMotionAreas>
          <CameraSerialNumber>string</CameraSerialNumber>
          <CameraType>string</CameraType>
          <SignalStrength>int</SignalStrength>
          <Dst>short</Dst>
          <VAVEnabled>short</VAVEnabled>
          <VideoQuality>short</VideoQuality>
          <SecurityPanelStatus>int</SecurityPanelStatus>
          <PartitionId>int</PartitionId>
          <AssociationStatus>int</AssociationStatus>
        </PartnerCameraSettings>
      </GetPartnerCameraSettingsResult>
    </GetPartnerCameraSettingsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPartnerCameraSettings xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <PartnerId>int</PartnerId>
      <LocationId>long</LocationId>
      <partnerCameraSerialNumber>string</partnerCameraSerialNumber>
    </GetPartnerCameraSettings>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPartnerCameraSettingsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetPartnerCameraSettingsResult>
        <PartnerCameraSettings>
          <AudioDetection>short</AudioDetection>
          <AudioSensitivity>int</AudioSensitivity>
          <LedStatus>short</LedStatus>
          <MicStatus>short</MicStatus>
          <MotionAarea>
            <MotionArea xsi:nil="true" />
            <MotionArea xsi:nil="true" />
          </MotionAarea>
          <MotionDetection>short</MotionDetection>
          <MotionZone>short</MotionZone>
          <NightMode>short</NightMode>
          <PrivacyMode>short</PrivacyMode>
          <RecordingAhead>int</RecordingAhead>
          <SpeakerStatus>short</SpeakerStatus>
          <StoragePlan>short</StoragePlan>
          <Timezone>string</Timezone>
          <Version>string</Version>
          <IPAddress>string</IPAddress>
          <MaxResolution>string</MaxResolution>
          <FirmwareVersion>string</FirmwareVersion>
          <FirmwareLastUpdated>string</FirmwareLastUpdated>
          <CameraName>string</CameraName>
          <MaxMotionAreas>int</MaxMotionAreas>
          <CameraSerialNumber>string</CameraSerialNumber>
          <CameraType>string</CameraType>
          <SignalStrength>int</SignalStrength>
          <Dst>short</Dst>
          <VAVEnabled>short</VAVEnabled>
          <VideoQuality>short</VideoQuality>
          <SecurityPanelStatus>int</SecurityPanelStatus>
          <PartitionId>int</PartitionId>
          <AssociationStatus>int</AssociationStatus>
        </PartnerCameraSettings>
      </GetPartnerCameraSettingsResult>
    </GetPartnerCameraSettingsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /tc21api/tc2.asmx/GetPartnerCameraSettings?SessionId=string&PartnerId=string&LocationId=string&partnerCameraSerialNumber=string HTTP/1.1
Host: rs.alarmnet.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<PartnerCameraSettingResults xmlns="https://services.alarmnet.com/TC2/">
  <PartnerCameraSettings>
    <AudioDetection>short</AudioDetection>
    <AudioSensitivity>int</AudioSensitivity>
    <LedStatus>short</LedStatus>
    <MicStatus>short</MicStatus>
    <MotionAarea>
      <MotionArea>
        <height>int</height>
        <sensitivity>int</sensitivity>
        <shape>string</shape>
        <start_x>int</start_x>
        <start_y>int</start_y>
        <width>int</width>
      </MotionArea>
      <MotionArea>
        <height>int</height>
        <sensitivity>int</sensitivity>
        <shape>string</shape>
        <start_x>int</start_x>
        <start_y>int</start_y>
        <width>int</width>
      </MotionArea>
    </MotionAarea>
    <MotionDetection>short</MotionDetection>
    <MotionZone>short</MotionZone>
    <NightMode>short</NightMode>
    <PrivacyMode>short</PrivacyMode>
    <RecordingAhead>int</RecordingAhead>
    <SpeakerStatus>short</SpeakerStatus>
    <StoragePlan>short</StoragePlan>
    <Timezone>string</Timezone>
    <Version>string</Version>
    <IPAddress>string</IPAddress>
    <MaxResolution>string</MaxResolution>
    <FirmwareVersion>string</FirmwareVersion>
    <FirmwareLastUpdated>string</FirmwareLastUpdated>
    <CameraName>string</CameraName>
    <MaxMotionAreas>int</MaxMotionAreas>
    <CameraSerialNumber>string</CameraSerialNumber>
    <CameraType>string</CameraType>
    <SignalStrength>int</SignalStrength>
    <Dst>short</Dst>
    <VAVEnabled>short</VAVEnabled>
    <VideoQuality>short</VideoQuality>
    <SecurityPanelStatus>int</SecurityPanelStatus>
    <PartitionId>int</PartitionId>
    <AssociationStatus>int</AssociationStatus>
  </PartnerCameraSettings>
</PartnerCameraSettingResults>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx/GetPartnerCameraSettings HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionId=string&PartnerId=string&LocationId=string&partnerCameraSerialNumber=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<PartnerCameraSettingResults xmlns="https://services.alarmnet.com/TC2/">
  <PartnerCameraSettings>
    <AudioDetection>short</AudioDetection>
    <AudioSensitivity>int</AudioSensitivity>
    <LedStatus>short</LedStatus>
    <MicStatus>short</MicStatus>
    <MotionAarea>
      <MotionArea>
        <height>int</height>
        <sensitivity>int</sensitivity>
        <shape>string</shape>
        <start_x>int</start_x>
        <start_y>int</start_y>
        <width>int</width>
      </MotionArea>
      <MotionArea>
        <height>int</height>
        <sensitivity>int</sensitivity>
        <shape>string</shape>
        <start_x>int</start_x>
        <start_y>int</start_y>
        <width>int</width>
      </MotionArea>
    </MotionAarea>
    <MotionDetection>short</MotionDetection>
    <MotionZone>short</MotionZone>
    <NightMode>short</NightMode>
    <PrivacyMode>short</PrivacyMode>
    <RecordingAhead>int</RecordingAhead>
    <SpeakerStatus>short</SpeakerStatus>
    <StoragePlan>short</StoragePlan>
    <Timezone>string</Timezone>
    <Version>string</Version>
    <IPAddress>string</IPAddress>
    <MaxResolution>string</MaxResolution>
    <FirmwareVersion>string</FirmwareVersion>
    <FirmwareLastUpdated>string</FirmwareLastUpdated>
    <CameraName>string</CameraName>
    <MaxMotionAreas>int</MaxMotionAreas>
    <CameraSerialNumber>string</CameraSerialNumber>
    <CameraType>string</CameraType>
    <SignalStrength>int</SignalStrength>
    <Dst>short</Dst>
    <VAVEnabled>short</VAVEnabled>
    <VideoQuality>short</VideoQuality>
    <SecurityPanelStatus>int</SecurityPanelStatus>
    <PartitionId>int</PartitionId>
    <AssociationStatus>int</AssociationStatus>
  </PartnerCameraSettings>
</PartnerCameraSettingResults>