GET api/v1/locations/{locationId}/devices/{deviceId}/partition/{partitionId}/zones

Return List of Zone Informations for given ZoneId's Equivalent SOAP API: GetIndividualZoneDetails

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID	integer	Required
deviceId	Device ID	integer	Required
partitionId	List of Bypass zones info.	integer	Required
ZoneIds		string	None.
LstZoneIds		Collection of integer	None.

Body Parameters

None.

Response Information

Resource Description

GetZoneInfoResults

Name	Type	Additional information
zoneInfos	Collection of ZoneInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "zoneInfos": [
    {
      "ZoneID": 1,
      "ZoneDescription": "sample string 2",
      "MaskDisabled": true,
      "ZoneStatus": 4,
      "IsFaulted": false,
      "IsTampered": false,
      "IsLowBattery": false,
      "IsInTrouble": false,
      "IsBypassed": false,
      "IsInAlarm": false,
      "IsInACLoss": false,
      "IsInObstructed": false,
      "IsInSupervisionFailure": false,
      "PartitionID": 5,
      "BatteryLevel": 1,
      "SignalStrength": 1
    },
    {
      "ZoneID": 1,
      "ZoneDescription": "sample string 2",
      "MaskDisabled": true,
      "ZoneStatus": 4,
      "IsFaulted": false,
      "IsTampered": false,
      "IsLowBattery": false,
      "IsInTrouble": false,
      "IsBypassed": false,
      "IsInAlarm": false,
      "IsInACLoss": false,
      "IsInObstructed": false,
      "IsInSupervisionFailure": false,
      "PartitionID": 5,
      "BatteryLevel": 1,
      "SignalStrength": 1
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<GetZoneInfoResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security">
  <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>
  <zoneInfos xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:ZoneInfo>
      <d2p1:BatteryLevel>1</d2p1:BatteryLevel>
      <d2p1:MaskDisabled>true</d2p1:MaskDisabled>
      <d2p1:PartitionID>5</d2p1:PartitionID>
      <d2p1:SignalStrength>1</d2p1:SignalStrength>
      <d2p1:ZoneDescription>sample string 2</d2p1:ZoneDescription>
      <d2p1:ZoneID>1</d2p1:ZoneID>
      <d2p1:ZoneStatus>4</d2p1:ZoneStatus>
    </d2p1:ZoneInfo>
    <d2p1:ZoneInfo>
      <d2p1:BatteryLevel>1</d2p1:BatteryLevel>
      <d2p1:MaskDisabled>true</d2p1:MaskDisabled>
      <d2p1:PartitionID>5</d2p1:PartitionID>
      <d2p1:SignalStrength>1</d2p1:SignalStrength>
      <d2p1:ZoneDescription>sample string 2</d2p1:ZoneDescription>
      <d2p1:ZoneID>1</d2p1:ZoneID>
      <d2p1:ZoneStatus>4</d2p1:ZoneStatus>
    </d2p1:ZoneInfo>
  </zoneInfos>
</GetZoneInfoResults>