PUT api/v1/locations/{locationId}/devices/{deviceId}/partitions/config

Configuring enabled feature for each partition-master user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

Location ID

integer

Required

deviceId

Device ID

integer

Required

Body Parameters

List of Partition Details

PartitionConfigurations
NameDescriptionTypeAdditional information
UserId

User ID

integer

None.

LstPartitionDetails

List of partition settings

Collection of PartitionDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": 1,
  "LstPartitionDetails": [
    {
      "PartitionName": "sample string 1",
      "IsStayArmed": true,
      "IsFireEnabled": true,
      "IsCommonEnabled": true,
      "IsLocked": true,
      "IsNewPartition": true,
      "IsNightStayEnabled": 7,
      "ExitDelayTimer": 8,
      "PartitionID": 9,
      "PartitionArmingState": 10,
      "ArmingState": 10,
      "OverrideArmingState": 11,
      "OverrideTimeStamp": "2025-04-01T23:49:58.5364983-04:00",
      "IsAlarmResponded": true,
      "AlarmTriggerTime": "2025-04-01T23:49:58.5364983-04:00",
      "AlarmTriggerTimeLocalized": "2025-04-01T23:49:58.5364983-04:00"
    },
    {
      "PartitionName": "sample string 1",
      "IsStayArmed": true,
      "IsFireEnabled": true,
      "IsCommonEnabled": true,
      "IsLocked": true,
      "IsNewPartition": true,
      "IsNightStayEnabled": 7,
      "ExitDelayTimer": 8,
      "PartitionID": 9,
      "PartitionArmingState": 10,
      "ArmingState": 10,
      "OverrideArmingState": 11,
      "OverrideTimeStamp": "2025-04-01T23:49:58.5364983-04:00",
      "IsAlarmResponded": true,
      "AlarmTriggerTime": "2025-04-01T23:49:58.5364983-04:00",
      "AlarmTriggerTimeLocalized": "2025-04-01T23:49:58.5364983-04:00"
    }
  ]
}

application/xml, text/xml

Sample:
<PartitionConfigurations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security">
  <LstPartitionDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:PartitionDetails>
      <d2p1:AlarmTriggerTime>2025-04-01T23:49:58.5364983-04:00</d2p1:AlarmTriggerTime>
      <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:49:58.5364983-04:00</d2p1:AlarmTriggerTimeLocalized>
      <d2p1:ArmingState>10</d2p1:ArmingState>
      <d2p1:IsAlarmResponded>true</d2p1:IsAlarmResponded>
      <d2p1:OverrideArmingState>11</d2p1:OverrideArmingState>
      <d2p1:OverrideTimeStamp>2025-04-01T23:49:58.5364983-04:00</d2p1:OverrideTimeStamp>
      <d2p1:PartitionID>9</d2p1:PartitionID>
      <d2p1:ExitDelayTimer>8</d2p1:ExitDelayTimer>
      <d2p1:IsCommonEnabled>true</d2p1:IsCommonEnabled>
      <d2p1:IsFireEnabled>true</d2p1:IsFireEnabled>
      <d2p1:IsLocked>true</d2p1:IsLocked>
      <d2p1:IsNewPartition>true</d2p1:IsNewPartition>
      <d2p1:IsNightStayEnabled>7</d2p1:IsNightStayEnabled>
      <d2p1:IsStayArmed>true</d2p1:IsStayArmed>
      <d2p1:PartitionName>sample string 1</d2p1:PartitionName>
    </d2p1:PartitionDetails>
    <d2p1:PartitionDetails>
      <d2p1:AlarmTriggerTime>2025-04-01T23:49:58.5364983-04:00</d2p1:AlarmTriggerTime>
      <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:49:58.5364983-04:00</d2p1:AlarmTriggerTimeLocalized>
      <d2p1:ArmingState>10</d2p1:ArmingState>
      <d2p1:IsAlarmResponded>true</d2p1:IsAlarmResponded>
      <d2p1:OverrideArmingState>11</d2p1:OverrideArmingState>
      <d2p1:OverrideTimeStamp>2025-04-01T23:49:58.5364983-04:00</d2p1:OverrideTimeStamp>
      <d2p1:PartitionID>9</d2p1:PartitionID>
      <d2p1:ExitDelayTimer>8</d2p1:ExitDelayTimer>
      <d2p1:IsCommonEnabled>true</d2p1:IsCommonEnabled>
      <d2p1:IsFireEnabled>true</d2p1:IsFireEnabled>
      <d2p1:IsLocked>true</d2p1:IsLocked>
      <d2p1:IsNewPartition>true</d2p1:IsNewPartition>
      <d2p1:IsNightStayEnabled>7</d2p1:IsNightStayEnabled>
      <d2p1:IsStayArmed>true</d2p1:IsStayArmed>
      <d2p1:PartitionName>sample string 1</d2p1:PartitionName>
    </d2p1:PartitionDetails>
  </LstPartitionDetails>
  <UserId>1</UserId>
</PartitionConfigurations>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResults

BaseResults
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:
<BaseResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">
  <ResultCode>1</ResultCode>
  <ResultData>sample string 2</ResultData>
</BaseResults>