POST api/locations/{locationId}/SecuritySystem/{deviceId}/CustomArm

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required
deviceId		integer	Required

Body Parameters

CustomArm

Name	Type	Additional information
ArmMode	integer	None.
ArmDelay	integer	None.
ZonesList	Collection of ZoneWithBypassInfoCustomArm	None.
partitions	Collection of integer	None.
armType	eArmType	None.
userCode	integer	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<CustomArm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <ArmDelay>2</ArmDelay>
  <ArmMode>1</ArmMode>
  <ZonesList>
    <ZoneWithBypassInfoCustomArm>
      <ByPass>true</ByPass>
      <ZoneID>1</ZoneID>
      <ZoneStatus>3</ZoneStatus>
    </ZoneWithBypassInfoCustomArm>
    <ZoneWithBypassInfoCustomArm>
      <ByPass>true</ByPass>
      <ZoneID>1</ZoneID>
      <ZoneStatus>3</ZoneStatus>
    </ZoneWithBypassInfoCustomArm>
  </ZonesList>
  <armType>ArmAway</armType>
  <partitions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </partitions>
  <userCode>1</userCode>
</CustomArm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomArmSecurityResults

None.

Response Formats

application/json, text/json

Sample:

{}

application/xml, text/xml

Sample:

<CustomArmSecurityResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models" />