GET api/v1/locations/{locationId}/device/{deviceId}

Retrieves latest custom Arm settings set by the user Equivalent SOAP API : GetCustomArmSettings

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required
deviceId		integer	Required

Body Parameters

None.

Response Information

Resource Description

CustomArmSettingsResult

Name	Type	Additional information
CustomArmDetails	CustomArmInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomArmDetails": {
    "ArmMode": 1,
    "ArmDelay": 2,
    "ZonesList": [
      {
        "ZoneID": 1,
        "ByPass": true,
        "ZoneStatus": 3
      },
      {
        "ZoneID": 1,
        "ByPass": true,
        "ZoneStatus": 3
      }
    ]
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<CustomArmSettingsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.ResultData">
  <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>
  <CustomArmDetails 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>
  </CustomArmDetails>
</CustomArmSettingsResult>