POST api/locations/{locationID}/SecuritySystem/{deviceID}/ZoneBypass

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

integer

Required

deviceID

integer

Required

Body Parameters

BypassZoneinfo
NameDescriptionTypeAdditional information
zoneids

Collection of integer

None.

usercode

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "zoneids": [
    1,
    2
  ],
  "usercode": 1
}

application/xml, text/xml

Sample:
<BypassZoneinfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <usercode>1</usercode>
  <zoneids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </zoneids>
</BypassZoneinfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BypassAllResults
NameDescriptionTypeAdditional information
ZoneBypassStatus

Collection of AllZoneBypassStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "ZoneBypassStatus": [
    {
      "ZoneID": 1,
      "ZoneStatus": 2
    },
    {
      "ZoneID": 1,
      "ZoneStatus": 2
    }
  ]
}

application/xml, text/xml

Sample:
<BypassAllResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.ResultData">
  <ZoneBypassStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
    <d2p1:AllZoneBypassStatus>
      <d2p1:ZoneID>1</d2p1:ZoneID>
      <d2p1:ZoneStatus>2</d2p1:ZoneStatus>
    </d2p1:AllZoneBypassStatus>
    <d2p1:AllZoneBypassStatus>
      <d2p1:ZoneID>1</d2p1:ZoneID>
      <d2p1:ZoneStatus>2</d2p1:ZoneStatus>
    </d2p1:AllZoneBypassStatus>
  </ZoneBypassStatus>
</BypassAllResults>