svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

GetCameraStatus

Return Lyric Camera and RSI Camera status.

Test

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

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/GetCameraStatus"

<?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>
    <GetCameraStatus xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
    </GetCameraStatus>
  </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>
    <GetCameraStatusResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetCameraStatusResult>
        <CameraStatus>
          <rsiStatusInfo>
            <RSIDeviceStatus xsi:nil="true" />
            <RSIDeviceStatus xsi:nil="true" />
          </rsiStatusInfo>
          <lyricCameraStatusInfo>
            <LyricCameraStatusInfo xsi:nil="true" />
            <LyricCameraStatusInfo xsi:nil="true" />
          </lyricCameraStatusInfo>
          <wifidoorbellinfo>
            <WiFiDoorBellInfo xsi:nil="true" />
            <WiFiDoorBellInfo xsi:nil="true" />
          </wifidoorbellinfo>
          <motionViewerStatusInfo>
            <MotionViewerCameraStatusInfo xsi:nil="true" />
            <MotionViewerCameraStatusInfo xsi:nil="true" />
          </motionViewerStatusInfo>
        </CameraStatus>
      </GetCameraStatusResult>
    </GetCameraStatusResponse>
  </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>
    <GetCameraStatus xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
    </GetCameraStatus>
  </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>
    <GetCameraStatusResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetCameraStatusResult>
        <CameraStatus>
          <rsiStatusInfo>
            <RSIDeviceStatus xsi:nil="true" />
            <RSIDeviceStatus xsi:nil="true" />
          </rsiStatusInfo>
          <lyricCameraStatusInfo>
            <LyricCameraStatusInfo xsi:nil="true" />
            <LyricCameraStatusInfo xsi:nil="true" />
          </lyricCameraStatusInfo>
          <wifidoorbellinfo>
            <WiFiDoorBellInfo xsi:nil="true" />
            <WiFiDoorBellInfo xsi:nil="true" />
          </wifidoorbellinfo>
          <motionViewerStatusInfo>
            <MotionViewerCameraStatusInfo xsi:nil="true" />
            <MotionViewerCameraStatusInfo xsi:nil="true" />
          </motionViewerStatusInfo>
        </CameraStatus>
      </GetCameraStatusResult>
    </GetCameraStatusResponse>
  </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/GetCameraStatus?SessionID=string&LocationID=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"?>
<CameraStatusResults xmlns="https://services.alarmnet.com/TC2/">
  <CameraStatus>
    <rsiStatusInfo>
      <RSIDeviceStatus>
        <RSIDeviceID>long</RSIDeviceID>
        <DevcieIndex>short</DevcieIndex>
        <BatteryStatus>short</BatteryStatus>
        <SupervisionStatus>short</SupervisionStatus>
        <CoverTamper>short</CoverTamper>
      </RSIDeviceStatus>
      <RSIDeviceStatus>
        <RSIDeviceID>long</RSIDeviceID>
        <DevcieIndex>short</DevcieIndex>
        <BatteryStatus>short</BatteryStatus>
        <SupervisionStatus>short</SupervisionStatus>
        <CoverTamper>short</CoverTamper>
      </RSIDeviceStatus>
    </rsiStatusInfo>
    <lyricCameraStatusInfo>
      <LyricCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <PrivacyMode>short</PrivacyMode>
        <OnlineStatus>short</OnlineStatus>
        <SignalStrength>int</SignalStrength>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>string</SnapShotCreatedDate>
        <LiveSnapShotURI>string</LiveSnapShotURI>
        <FirmwareUpgradeStatus>short</FirmwareUpgradeStatus>
        <RebootRequired>int</RebootRequired>
      </LyricCameraStatusInfo>
      <LyricCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <PrivacyMode>short</PrivacyMode>
        <OnlineStatus>short</OnlineStatus>
        <SignalStrength>int</SignalStrength>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>string</SnapShotCreatedDate>
        <LiveSnapShotURI>string</LiveSnapShotURI>
        <FirmwareUpgradeStatus>short</FirmwareUpgradeStatus>
        <RebootRequired>int</RebootRequired>
      </LyricCameraStatusInfo>
    </lyricCameraStatusInfo>
    <wifidoorbellinfo>
      <WiFiDoorBellInfo>
        <DeviceID>long</DeviceID>
        <DeviceModel>int</DeviceModel>
        <TimeZoneID>int</TimeZoneID>
        <State>string</State>
        <SetupStateID>int</SetupStateID>
        <WiFiName>string</WiFiName>
        <LEDColorInDevice>string</LEDColorInDevice>
        <IsExistingDoorBellUser>int</IsExistingDoorBellUser>
        <LockID>long</LockID>
        <IsMotionEnabled>int</IsMotionEnabled>
        <SetupErrorID>int</SetupErrorID>
        <PartnerDeviceID>string</PartnerDeviceID>
        <PartnerDeviceName>string</PartnerDeviceName>
        <PartitionId>int</PartitionId>
        <AssociationStatus>int</AssociationStatus>
        <DeviceSerialText>string</DeviceSerialText>
      </WiFiDoorBellInfo>
      <WiFiDoorBellInfo>
        <DeviceID>long</DeviceID>
        <DeviceModel>int</DeviceModel>
        <TimeZoneID>int</TimeZoneID>
        <State>string</State>
        <SetupStateID>int</SetupStateID>
        <WiFiName>string</WiFiName>
        <LEDColorInDevice>string</LEDColorInDevice>
        <IsExistingDoorBellUser>int</IsExistingDoorBellUser>
        <LockID>long</LockID>
        <IsMotionEnabled>int</IsMotionEnabled>
        <SetupErrorID>int</SetupErrorID>
        <PartnerDeviceID>string</PartnerDeviceID>
        <PartnerDeviceName>string</PartnerDeviceName>
        <PartitionId>int</PartitionId>
        <AssociationStatus>int</AssociationStatus>
        <DeviceSerialText>string</DeviceSerialText>
      </WiFiDoorBellInfo>
    </wifidoorbellinfo>
    <motionViewerStatusInfo>
      <MotionViewerCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <LowBattery>short</LowBattery>
        <Fault>short</Fault>
        <SupervisionFailure>short</SupervisionFailure>
        <OnlineStatus>short</OnlineStatus>
        <Alarm>short</Alarm>
        <Bypass>short</Bypass>
        <Trouble>short</Trouble>
        <Tamper>short</Tamper>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>dateTime</SnapShotCreatedDate>
        <MediaId>string</MediaId>
        <VoDEnabled>boolean</VoDEnabled>
      </MotionViewerCameraStatusInfo>
      <MotionViewerCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <LowBattery>short</LowBattery>
        <Fault>short</Fault>
        <SupervisionFailure>short</SupervisionFailure>
        <OnlineStatus>short</OnlineStatus>
        <Alarm>short</Alarm>
        <Bypass>short</Bypass>
        <Trouble>short</Trouble>
        <Tamper>short</Tamper>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>dateTime</SnapShotCreatedDate>
        <MediaId>string</MediaId>
        <VoDEnabled>boolean</VoDEnabled>
      </MotionViewerCameraStatusInfo>
    </motionViewerStatusInfo>
  </CameraStatus>
</CameraStatusResults>

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/GetCameraStatus HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&LocationID=string

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

<?xml version="1.0" encoding="utf-8"?>
<CameraStatusResults xmlns="https://services.alarmnet.com/TC2/">
  <CameraStatus>
    <rsiStatusInfo>
      <RSIDeviceStatus>
        <RSIDeviceID>long</RSIDeviceID>
        <DevcieIndex>short</DevcieIndex>
        <BatteryStatus>short</BatteryStatus>
        <SupervisionStatus>short</SupervisionStatus>
        <CoverTamper>short</CoverTamper>
      </RSIDeviceStatus>
      <RSIDeviceStatus>
        <RSIDeviceID>long</RSIDeviceID>
        <DevcieIndex>short</DevcieIndex>
        <BatteryStatus>short</BatteryStatus>
        <SupervisionStatus>short</SupervisionStatus>
        <CoverTamper>short</CoverTamper>
      </RSIDeviceStatus>
    </rsiStatusInfo>
    <lyricCameraStatusInfo>
      <LyricCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <PrivacyMode>short</PrivacyMode>
        <OnlineStatus>short</OnlineStatus>
        <SignalStrength>int</SignalStrength>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>string</SnapShotCreatedDate>
        <LiveSnapShotURI>string</LiveSnapShotURI>
        <FirmwareUpgradeStatus>short</FirmwareUpgradeStatus>
        <RebootRequired>int</RebootRequired>
      </LyricCameraStatusInfo>
      <LyricCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <PrivacyMode>short</PrivacyMode>
        <OnlineStatus>short</OnlineStatus>
        <SignalStrength>int</SignalStrength>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>string</SnapShotCreatedDate>
        <LiveSnapShotURI>string</LiveSnapShotURI>
        <FirmwareUpgradeStatus>short</FirmwareUpgradeStatus>
        <RebootRequired>int</RebootRequired>
      </LyricCameraStatusInfo>
    </lyricCameraStatusInfo>
    <wifidoorbellinfo>
      <WiFiDoorBellInfo>
        <DeviceID>long</DeviceID>
        <DeviceModel>int</DeviceModel>
        <TimeZoneID>int</TimeZoneID>
        <State>string</State>
        <SetupStateID>int</SetupStateID>
        <WiFiName>string</WiFiName>
        <LEDColorInDevice>string</LEDColorInDevice>
        <IsExistingDoorBellUser>int</IsExistingDoorBellUser>
        <LockID>long</LockID>
        <IsMotionEnabled>int</IsMotionEnabled>
        <SetupErrorID>int</SetupErrorID>
        <PartnerDeviceID>string</PartnerDeviceID>
        <PartnerDeviceName>string</PartnerDeviceName>
        <PartitionId>int</PartitionId>
        <AssociationStatus>int</AssociationStatus>
        <DeviceSerialText>string</DeviceSerialText>
      </WiFiDoorBellInfo>
      <WiFiDoorBellInfo>
        <DeviceID>long</DeviceID>
        <DeviceModel>int</DeviceModel>
        <TimeZoneID>int</TimeZoneID>
        <State>string</State>
        <SetupStateID>int</SetupStateID>
        <WiFiName>string</WiFiName>
        <LEDColorInDevice>string</LEDColorInDevice>
        <IsExistingDoorBellUser>int</IsExistingDoorBellUser>
        <LockID>long</LockID>
        <IsMotionEnabled>int</IsMotionEnabled>
        <SetupErrorID>int</SetupErrorID>
        <PartnerDeviceID>string</PartnerDeviceID>
        <PartnerDeviceName>string</PartnerDeviceName>
        <PartitionId>int</PartitionId>
        <AssociationStatus>int</AssociationStatus>
        <DeviceSerialText>string</DeviceSerialText>
      </WiFiDoorBellInfo>
    </wifidoorbellinfo>
    <motionViewerStatusInfo>
      <MotionViewerCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <LowBattery>short</LowBattery>
        <Fault>short</Fault>
        <SupervisionFailure>short</SupervisionFailure>
        <OnlineStatus>short</OnlineStatus>
        <Alarm>short</Alarm>
        <Bypass>short</Bypass>
        <Trouble>short</Trouble>
        <Tamper>short</Tamper>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>dateTime</SnapShotCreatedDate>
        <MediaId>string</MediaId>
        <VoDEnabled>boolean</VoDEnabled>
      </MotionViewerCameraStatusInfo>
      <MotionViewerCameraStatusInfo>
        <DeviceID>long</DeviceID>
        <CameraSerialNumber>string</CameraSerialNumber>
        <LowBattery>short</LowBattery>
        <Fault>short</Fault>
        <SupervisionFailure>short</SupervisionFailure>
        <OnlineStatus>short</OnlineStatus>
        <Alarm>short</Alarm>
        <Bypass>short</Bypass>
        <Trouble>short</Trouble>
        <Tamper>short</Tamper>
        <SnapShotURI>string</SnapShotURI>
        <SnapShotCreatedDate>dateTime</SnapShotCreatedDate>
        <MediaId>string</MediaId>
        <VoDEnabled>boolean</VoDEnabled>
      </MotionViewerCameraStatusInfo>
    </motionViewerStatusInfo>
  </CameraStatus>
</CameraStatusResults>

Parameter	Value
SessionID:
LocationID: