PUT api/v1/locations/{locationId}/devices/{deviceId}/bypass

Initiates Zone Bypass for multiple zones

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID	integer	Required
deviceId	Device ID	integer	Required

Body Parameters

List of Bypass zones info.

BypassZones

Name	Description	Type	Additional information
ZoneIds	List of Zone Id	Collection of integer	None.
UserCode	User code	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ZoneIds": [
    1,
    2
  ],
  "UserCode": 1
}

application/xml, text/xml

Sample:

<BypassZones xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security">
  <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>
</BypassZones>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of ZoneBypassStatus

ZoneStatusResults

Name	Type	Additional information
Zones	Collection of ZoneBypassStatus	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Zones": [
    {
      "ZoneID": 1,
      "ZoneStatus": 2
    },
    {
      "ZoneID": 1,
      "ZoneStatus": 2
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<ZoneStatusResults 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>
  <Zones xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:ZoneBypassStatus>
      <d2p1:ZoneID>1</d2p1:ZoneID>
      <d2p1:ZoneStatus>2</d2p1:ZoneStatus>
    </d2p1:ZoneBypassStatus>
    <d2p1:ZoneBypassStatus>
      <d2p1:ZoneID>1</d2p1:ZoneID>
      <d2p1:ZoneStatus>2</d2p1:ZoneStatus>
    </d2p1:ZoneBypassStatus>
  </Zones>
</ZoneStatusResults>