PUT api/v4/locations/{locationId}/devices/{deviceId}/partitions/arm

Arm the Security System

Request Information

URI Parameters

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

Body Parameters

ArmRequest

Name	Type	Additional information
UserId	integer	None.
armType	integer	None.
userCode	integer	None.
partitions	Collection of integer	None.
CustomArmInfo	CustomArmInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "armType": 2,
  "userCode": 3,
  "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:

<ArmRequest 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>2</armType>
  <partitions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </partitions>
  <userCode>3</userCode>
  <UserId>1</UserId>
</ArmRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArmSecuritySystemResults

ArmSecuritySystemPartitionResults

Name	Type	Additional information
StatusChange	PartitionsStateChange	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusChange": {
    "PartitionStateChange": [
      {
        "PartitionId": 1,
        "Result": 2
      },
      {
        "PartitionId": 1,
        "Result": 2
      }
    ]
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<ArmSecuritySystemPartitionResults 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>
  <StatusChange xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:PartitionStateChange>
      <d2p1:PartitionCommentStateChange>
        <d2p1:PartitionId>1</d2p1:PartitionId>
        <d2p1:Result>2</d2p1:Result>
      </d2p1:PartitionCommentStateChange>
      <d2p1:PartitionCommentStateChange>
        <d2p1:PartitionId>1</d2p1:PartitionId>
        <d2p1:Result>2</d2p1:Result>
      </d2p1:PartitionCommentStateChange>
    </d2p1:PartitionStateChange>
    <d2p1:ResultCode>2</d2p1:ResultCode>
    <d2p1:ResultData>sample string 3</d2p1:ResultData>
    <d2p1:SessionID>1</d2p1:SessionID>
  </StatusChange>
</ArmSecuritySystemPartitionResults>