PUT api/v2/locations/{locationId}/devices/{deviceId}/clearBypass

Disarm the Security System

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

Location ID

integer

Required

deviceId

Device ID

integer

Required

Body Parameters

ArmInfo object

ArmInfo
NameDescriptionTypeAdditional information
armType

integer

None.

userCode

integer

None.

partitions

Collection of integer

None.

CustomArmInfo

CustomArmInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "armType": 1,
  "userCode": 2,
  "partitions": [
    1,
    2
  ],
  "CustomArmInfo": {
    "ArmMode": 1,
    "ArmDelay": 2,
    "ZonesList": [
      {
        "ZoneID": 1,
        "ByPass": true,
        "ZoneStatus": 3
      },
      {
        "ZoneID": 1,
        "ByPass": true,
        "ZoneStatus": 3
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ArmInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
  <CustomArmInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:ArmDelay>2</d2p1:ArmDelay>
    <d2p1:ArmMode>1</d2p1:ArmMode>
    <d2p1:ZonesList>
      <d2p1:ZoneWithBypassInfo>
        <d2p1:ByPass>true</d2p1:ByPass>
        <d2p1:ZoneID>1</d2p1:ZoneID>
        <d2p1:ZoneStatus>3</d2p1:ZoneStatus>
      </d2p1:ZoneWithBypassInfo>
      <d2p1:ZoneWithBypassInfo>
        <d2p1:ByPass>true</d2p1:ByPass>
        <d2p1:ZoneID>1</d2p1:ZoneID>
        <d2p1:ZoneStatus>3</d2p1:ZoneStatus>
      </d2p1:ZoneWithBypassInfo>
    </d2p1:ZonesList>
  </CustomArmInfo>
  <armType>1</armType>
  <partitions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </partitions>
  <userCode>2</userCode>
</ArmInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClearBypassResults

ClearBypassPartitionResults
NameDescriptionTypeAdditional information
ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

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