GET api/v1/videopir/videoDeviceList/locations/{locationId}/additional/{additionalInfo}

Retrieve the list of Video PIR for the specified session and location.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

location Id

integer

Required

additionalInfo

additionalInfo

string

Required

Body Parameters

None.

Response Information

Resource Description

VideoPIRListResults

VideoPIRListResults
NameDescriptionTypeAdditional information
SessionID

string

None.

VideoPIRList

Collection of VideoPIRInfo

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SessionID": "sample string 1",
  "VideoPIRList": [
    {
      "DeviceID": 1,
      "DeviceClassID": 2,
      "MAC": "sample string 3",
      "DeviceName": "sample string 4",
      "BatteryStatus": 5,
      "FirmwareAvailablity": 6,
      "FirmwareDownLoad": 7,
      "WifiStatus": 9,
      "VideoPIREventInfo": {
        "EventID": 1,
        "ImageURL": "sample string 2",
        "EventImageCount": 3,
        "ImageDateTime": "2025-04-01T23:58:30.8796723-04:00",
        "ImageDateTimeUTC": "2025-04-01T23:58:30.8796723-04:00",
        "CaptureTypeID": 6,
        "ImageRequestID": "sample string 7",
        "TMSMediaID": "sample string 8"
      }
    },
    {
      "DeviceID": 1,
      "DeviceClassID": 2,
      "MAC": "sample string 3",
      "DeviceName": "sample string 4",
      "BatteryStatus": 5,
      "FirmwareAvailablity": 6,
      "FirmwareDownLoad": 7,
      "WifiStatus": 9,
      "VideoPIREventInfo": {
        "EventID": 1,
        "ImageURL": "sample string 2",
        "EventImageCount": 3,
        "ImageDateTime": "2025-04-01T23:58:30.8796723-04:00",
        "ImageDateTimeUTC": "2025-04-01T23:58:30.8796723-04:00",
        "CaptureTypeID": 6,
        "ImageRequestID": "sample string 7",
        "TMSMediaID": "sample string 8"
      }
    }
  ],
  "ResultCode": 2,
  "ResultData": "sample string 3"
}

application/xml, text/xml

Sample:
<VideoPIRListResults 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">2</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
  <SessionID>sample string 1</SessionID>
  <VideoPIRList xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.VideoPIR">
    <d2p1:VideoPIRInfo>
      <d2p1:BatteryStatus>5</d2p1:BatteryStatus>
      <d2p1:DeviceClassID>2</d2p1:DeviceClassID>
      <d2p1:DeviceID>1</d2p1:DeviceID>
      <d2p1:DeviceName>sample string 4</d2p1:DeviceName>
      <d2p1:FirmwareAvailablity>6</d2p1:FirmwareAvailablity>
      <d2p1:FirmwareDownLoad>7</d2p1:FirmwareDownLoad>
      <d2p1:MAC>sample string 3</d2p1:MAC>
      <d2p1:Pir>8</d2p1:Pir>
      <d2p1:VideoPIREventInfo>
        <d2p1:CaptureTypeID>6</d2p1:CaptureTypeID>
        <d2p1:EventID>1</d2p1:EventID>
        <d2p1:EventImageCount>3</d2p1:EventImageCount>
        <d2p1:ImageDateTime>2025-04-01T23:58:30.8796723-04:00</d2p1:ImageDateTime>
        <d2p1:ImageDateTimeUTC>2025-04-01T23:58:30.8796723-04:00</d2p1:ImageDateTimeUTC>
        <d2p1:ImageRequestID>sample string 7</d2p1:ImageRequestID>
        <d2p1:ImageURL>sample string 2</d2p1:ImageURL>
        <d2p1:TMSMediaID>sample string 8</d2p1:TMSMediaID>
      </d2p1:VideoPIREventInfo>
      <d2p1:WifiStatus>9</d2p1:WifiStatus>
    </d2p1:VideoPIRInfo>
    <d2p1:VideoPIRInfo>
      <d2p1:BatteryStatus>5</d2p1:BatteryStatus>
      <d2p1:DeviceClassID>2</d2p1:DeviceClassID>
      <d2p1:DeviceID>1</d2p1:DeviceID>
      <d2p1:DeviceName>sample string 4</d2p1:DeviceName>
      <d2p1:FirmwareAvailablity>6</d2p1:FirmwareAvailablity>
      <d2p1:FirmwareDownLoad>7</d2p1:FirmwareDownLoad>
      <d2p1:MAC>sample string 3</d2p1:MAC>
      <d2p1:Pir>8</d2p1:Pir>
      <d2p1:VideoPIREventInfo>
        <d2p1:CaptureTypeID>6</d2p1:CaptureTypeID>
        <d2p1:EventID>1</d2p1:EventID>
        <d2p1:EventImageCount>3</d2p1:EventImageCount>
        <d2p1:ImageDateTime>2025-04-01T23:58:30.8796723-04:00</d2p1:ImageDateTime>
        <d2p1:ImageDateTimeUTC>2025-04-01T23:58:30.8796723-04:00</d2p1:ImageDateTimeUTC>
        <d2p1:ImageRequestID>sample string 7</d2p1:ImageRequestID>
        <d2p1:ImageURL>sample string 2</d2p1:ImageURL>
        <d2p1:TMSMediaID>sample string 8</d2p1:TMSMediaID>
      </d2p1:VideoPIREventInfo>
      <d2p1:WifiStatus>9</d2p1:WifiStatus>
    </d2p1:VideoPIRInfo>
  </VideoPIRList>
</VideoPIRListResults>