svcTC2API
Click here for a complete list of operations.
GetVideoPIRLocationDeviceList
Retrieve the list of Video PIR for the specified session and location.
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/GetVideoPIRLocationDeviceList" <?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> <GetVideoPIRLocationDeviceList xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <LocationID>long</LocationID> <AdditionalInfo>string</AdditionalInfo> </GetVideoPIRLocationDeviceList> </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> <GetVideoPIRLocationDeviceListResponse xmlns="https://services.alarmnet.com/TC2/"> <GetVideoPIRLocationDeviceListResult> <SessionID>string</SessionID> <VideoPIRList> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo xsi:nil="true" /> </VideoPIRInfo> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo xsi:nil="true" /> </VideoPIRInfo> </VideoPIRList> </GetVideoPIRLocationDeviceListResult> </GetVideoPIRLocationDeviceListResponse> </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> <GetVideoPIRLocationDeviceList xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <LocationID>long</LocationID> <AdditionalInfo>string</AdditionalInfo> </GetVideoPIRLocationDeviceList> </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> <GetVideoPIRLocationDeviceListResponse xmlns="https://services.alarmnet.com/TC2/"> <GetVideoPIRLocationDeviceListResult> <SessionID>string</SessionID> <VideoPIRList> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo xsi:nil="true" /> </VideoPIRInfo> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo xsi:nil="true" /> </VideoPIRInfo> </VideoPIRList> </GetVideoPIRLocationDeviceListResult> </GetVideoPIRLocationDeviceListResponse> </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/GetVideoPIRLocationDeviceList?SessionID=string&LocationID=string&AdditionalInfo=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"?> <VideoPIRListResults xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <VideoPIRList> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo> <EventID>long</EventID> <ImageURL>string</ImageURL> <EventImageCount>int</EventImageCount> <ImageDateTime>dateTime</ImageDateTime> <ImageDateTimeUTC>dateTime</ImageDateTimeUTC> <CaptureTypeID>int</CaptureTypeID> <ImageRequestID>string</ImageRequestID> <TMSMediaID>string</TMSMediaID> </VideoPIREventInfo> </VideoPIRInfo> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo> <EventID>long</EventID> <ImageURL>string</ImageURL> <EventImageCount>int</EventImageCount> <ImageDateTime>dateTime</ImageDateTime> <ImageDateTimeUTC>dateTime</ImageDateTimeUTC> <CaptureTypeID>int</CaptureTypeID> <ImageRequestID>string</ImageRequestID> <TMSMediaID>string</TMSMediaID> </VideoPIREventInfo> </VideoPIRInfo> </VideoPIRList> </VideoPIRListResults>
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/GetVideoPIRLocationDeviceList HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&LocationID=string&AdditionalInfo=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <VideoPIRListResults xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <VideoPIRList> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo> <EventID>long</EventID> <ImageURL>string</ImageURL> <EventImageCount>int</EventImageCount> <ImageDateTime>dateTime</ImageDateTime> <ImageDateTimeUTC>dateTime</ImageDateTimeUTC> <CaptureTypeID>int</CaptureTypeID> <ImageRequestID>string</ImageRequestID> <TMSMediaID>string</TMSMediaID> </VideoPIREventInfo> </VideoPIRInfo> <VideoPIRInfo> <DeviceID>long</DeviceID> <DeviceClassID>int</DeviceClassID> <MAC>string</MAC> <DeviceName>string</DeviceName> <BatteryStatus>int</BatteryStatus> <FirmwareAvailablity>int</FirmwareAvailablity> <FirmwareDownLoad>int</FirmwareDownLoad> <WifiStatus>int</WifiStatus> <VideoPIREventInfo> <EventID>long</EventID> <ImageURL>string</ImageURL> <EventImageCount>int</EventImageCount> <ImageDateTime>dateTime</ImageDateTime> <ImageDateTimeUTC>dateTime</ImageDateTimeUTC> <CaptureTypeID>int</CaptureTypeID> <ImageRequestID>string</ImageRequestID> <TMSMediaID>string</TMSMediaID> </VideoPIREventInfo> </VideoPIRInfo> </VideoPIRList> </VideoPIRListResults>