POST api/v1/locations/{locationId}/AutomationDevice/addEdit

To add or Edit the SmartAction or SmartScene

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	location	integer	Required

Body Parameters

smartscene

ActionSceneInfo

Name	Type	Additional information
SmartActionSceneID	integer	None.
SmartActionSceneIndex	integer	None.
Name	string	None.
TriggerType	integer	None.
IsSmartActionSceneEnabled	boolean	None.
State	integer	None.
SyncStatus	integer	None.
SmartActionSceneIconID	integer	None.
Created	date	None.
SwitchSubActions	Collection of SwitchSubAction	None.
LockSubActions	Collection of LockSubAction	None.
SceneSwitchSubActions	Collection of SceneSwitchSubAction	None.
SceneLockSubActions	Collection of SceneLockSubAction	None.
ThermostatSubActions	Collection of ThermostatSubAction	None.
SceneThermostatSubActions	Collection of SceneThermostatSubAction	None.
WifiThermostatSubActions	Collection of WifiThermostatSubAction	None.
CameraSubActions	Collection of CameraSubAction	None.
SecuritySubActions	Collection of SecuritySubAction	None.
TriggerEvent	SmartActionTriggerEvent	None.
SceneTimeTriggeredAction	ScenesTimeTriggeredAction	None.
ScenesTriggerEvent	ScenesTriggerEvent	None.
Schedule	SmartActionSchedule	None.
GeoFenceTriggerType	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SmartActionSceneID": 1,
  "SmartActionSceneIndex": 2,
  "Name": "sample string 4",
  "TriggerType": 5,
  "IsSmartActionSceneEnabled": true,
  "State": 7,
  "SyncStatus": 8,
  "SmartActionSceneIconID": 9,
  "Created": "2025-04-01T23:48:17.2889201-04:00",
  "SwitchSubActions": [
    {
      "SubActionID": 1,
      "SwitchType": 2,
      "SwitchID": 3,
      "State": 4,
      "Level": 5,
      "DeviceDuration": 6
    },
    {
      "SubActionID": 1,
      "SwitchType": 2,
      "SwitchID": 3,
      "State": 4,
      "Level": 5,
      "DeviceDuration": 6
    }
  ],
  "LockSubActions": [
    {
      "SubActionID": 1,
      "LockID": 2,
      "State": 3,
      "AuthorizationCode": 4
    },
    {
      "SubActionID": 1,
      "LockID": 2,
      "State": 3,
      "AuthorizationCode": 4
    }
  ],
  "SceneSwitchSubActions": [
    {
      "SwitchID": 1,
      "SwitchState": 2,
      "SwitchType": 3,
      "SwitchLevel": 4
    },
    {
      "SwitchID": 1,
      "SwitchState": 2,
      "SwitchType": 3,
      "SwitchLevel": 4
    }
  ],
  "SceneLockSubActions": [
    {
      "LockID": 1,
      "LockState": true,
      "AuthorizationCode": "sample string 3"
    },
    {
      "LockID": 1,
      "LockState": true,
      "AuthorizationCode": "sample string 3"
    }
  ],
  "ThermostatSubActions": [
    {
      "SubActionID": 1,
      "ThermostatID": 2,
      "Mode": 3,
      "FanMode": 4,
      "HeatSetPoint": 5,
      "CoolSetPoint": 6
    },
    {
      "SubActionID": 1,
      "ThermostatID": 2,
      "Mode": 3,
      "FanMode": 4,
      "HeatSetPoint": 5,
      "CoolSetPoint": 6
    }
  ],
  "SceneThermostatSubActions": [
    {
      "ThermostatID": 1,
      "ModeID": 2,
      "FanMode": 3,
      "HeatSetPoint": 4,
      "CoolSetPoint": 5
    },
    {
      "ThermostatID": 1,
      "ModeID": 2,
      "FanMode": 3,
      "HeatSetPoint": 4,
      "CoolSetPoint": 5
    }
  ],
  "WifiThermostatSubActions": [
    {
      "SubActionID": 1,
      "WifiThermostatID": 2,
      "Mode": 3,
      "FanMode": 4,
      "HeatSetPoint": 5,
      "CoolSetPoint": 6
    },
    {
      "SubActionID": 1,
      "WifiThermostatID": 2,
      "Mode": 3,
      "FanMode": 4,
      "HeatSetPoint": 5,
      "CoolSetPoint": 6
    }
  ],
  "CameraSubActions": [
    {
      "SubActionID": 1,
      "DeviceID": 2,
      "Type": 3,
      "Action": 4,
      "ZoneID": 5
    },
    {
      "SubActionID": 1,
      "DeviceID": 2,
      "Type": 3,
      "Action": 4,
      "ZoneID": 5
    }
  ],
  "SecuritySubActions": [
    {
      "SubActionID": 1,
      "SecuritySystemID": 2,
      "State": 3,
      "ByPassZones": [
        1,
        2
      ]
    },
    {
      "SubActionID": 1,
      "SecuritySystemID": 2,
      "State": 3,
      "ByPassZones": [
        1,
        2
      ]
    }
  ],
  "TriggerEvent": {
    "SmartActionTriggerEventID": 1,
    "SecurityTriggerEvent": 2,
    "SecurityTriggerDeviceID": 3,
    "DeviceID": 4,
    "TriggerZoneID": 5,
    "TriggerZoneType": 6,
    "TriggerEventType": 7,
    "DeviceState": 8
  },
  "SceneTimeTriggeredAction": {
    "DeviceID": 1,
    "EventItemID": 2,
    "TriggerTime": "sample string 3",
    "SelectedDayID": 4,
    "IsEnabled": true,
    "FlashEventCardType": 6,
    "IsNew": false,
    "FrequencyTypeID": 4
  },
  "ScenesTriggerEvent": {
    "EventTypeID": 1,
    "EventItemID": 2,
    "EventModifierID": 3,
    "DeviceID": 4,
    "IsEnabled": true,
    "FlashEventCardType": 6,
    "IsNew": false
  },
  "Schedule": {
    "SmartActionScheduleID": 1,
    "FrequencyType": 2,
    "ScheduleDate": "sample string 3",
    "DayOfWeek": [
      1,
      2
    ],
    "DayOfMonth": [
      1,
      2
    ],
    "StartTime": "sample string 4",
    "Sunrise": 5,
    "Sunset": 6,
    "RandomMinutesBefore": 7,
    "RandomMinutesAfter": 8
  },
  "GeoFenceTriggerType": 11
}

application/xml, text/xml

Sample:

<ActionSceneInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
  <CameraSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:CameraSubAction>
      <d2p1:Action>4</d2p1:Action>
      <d2p1:DeviceID>2</d2p1:DeviceID>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:Type>3</d2p1:Type>
      <d2p1:ZoneID>5</d2p1:ZoneID>
    </d2p1:CameraSubAction>
    <d2p1:CameraSubAction>
      <d2p1:Action>4</d2p1:Action>
      <d2p1:DeviceID>2</d2p1:DeviceID>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:Type>3</d2p1:Type>
      <d2p1:ZoneID>5</d2p1:ZoneID>
    </d2p1:CameraSubAction>
  </CameraSubActions>
  <GeoFenceTriggerType>11</GeoFenceTriggerType>
  <LockSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:LockSubAction>
      <d2p1:AuthorizationCode>4</d2p1:AuthorizationCode>
      <d2p1:LockID>2</d2p1:LockID>
      <d2p1:State>3</d2p1:State>
      <d2p1:SubActionID>1</d2p1:SubActionID>
    </d2p1:LockSubAction>
    <d2p1:LockSubAction>
      <d2p1:AuthorizationCode>4</d2p1:AuthorizationCode>
      <d2p1:LockID>2</d2p1:LockID>
      <d2p1:State>3</d2p1:State>
      <d2p1:SubActionID>1</d2p1:SubActionID>
    </d2p1:LockSubAction>
  </LockSubActions>
  <SceneLockSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartScene">
    <d2p1:SceneLockSubAction>
      <d2p1:AuthorizationCode>sample string 3</d2p1:AuthorizationCode>
      <d2p1:LockID>1</d2p1:LockID>
      <d2p1:LockState>true</d2p1:LockState>
    </d2p1:SceneLockSubAction>
    <d2p1:SceneLockSubAction>
      <d2p1:AuthorizationCode>sample string 3</d2p1:AuthorizationCode>
      <d2p1:LockID>1</d2p1:LockID>
      <d2p1:LockState>true</d2p1:LockState>
    </d2p1:SceneLockSubAction>
  </SceneLockSubActions>
  <SceneSwitchSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartScene">
    <d2p1:SceneSwitchSubAction>
      <d2p1:SwitchID>1</d2p1:SwitchID>
      <d2p1:SwitchLevel>4</d2p1:SwitchLevel>
      <d2p1:SwitchState>2</d2p1:SwitchState>
      <d2p1:SwitchType>3</d2p1:SwitchType>
    </d2p1:SceneSwitchSubAction>
    <d2p1:SceneSwitchSubAction>
      <d2p1:SwitchID>1</d2p1:SwitchID>
      <d2p1:SwitchLevel>4</d2p1:SwitchLevel>
      <d2p1:SwitchState>2</d2p1:SwitchState>
      <d2p1:SwitchType>3</d2p1:SwitchType>
    </d2p1:SceneSwitchSubAction>
  </SceneSwitchSubActions>
  <SceneThermostatSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartScene">
    <d2p1:SceneThermostatSubAction>
      <d2p1:CoolSetPoint>5</d2p1:CoolSetPoint>
      <d2p1:FanMode>3</d2p1:FanMode>
      <d2p1:HeatSetPoint>4</d2p1:HeatSetPoint>
      <d2p1:ModeID>2</d2p1:ModeID>
      <d2p1:ThermostatID>1</d2p1:ThermostatID>
    </d2p1:SceneThermostatSubAction>
    <d2p1:SceneThermostatSubAction>
      <d2p1:CoolSetPoint>5</d2p1:CoolSetPoint>
      <d2p1:FanMode>3</d2p1:FanMode>
      <d2p1:HeatSetPoint>4</d2p1:HeatSetPoint>
      <d2p1:ModeID>2</d2p1:ModeID>
      <d2p1:ThermostatID>1</d2p1:ThermostatID>
    </d2p1:SceneThermostatSubAction>
  </SceneThermostatSubActions>
  <SceneTimeTriggeredAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartScene">
    <d2p1:DeviceID>1</d2p1:DeviceID>
    <d2p1:EventItemID>2</d2p1:EventItemID>
    <d2p1:FlashEventCardType>6</d2p1:FlashEventCardType>
    <d2p1:IsEnabled>true</d2p1:IsEnabled>
    <d2p1:SelectedDayID>4</d2p1:SelectedDayID>
    <d2p1:TriggerTime>sample string 3</d2p1:TriggerTime>
  </SceneTimeTriggeredAction>
  <ScenesTriggerEvent xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartScene">
    <d2p1:DeviceID>4</d2p1:DeviceID>
    <d2p1:EventItemID>2</d2p1:EventItemID>
    <d2p1:EventModifierID>3</d2p1:EventModifierID>
    <d2p1:EventTypeID>1</d2p1:EventTypeID>
    <d2p1:FlashEventCardType>6</d2p1:FlashEventCardType>
    <d2p1:IsEnabled>true</d2p1:IsEnabled>
  </ScenesTriggerEvent>
  <Schedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:DayOfMonth xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:DayOfMonth>
    <d2p1:DayOfWeek xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:DayOfWeek>
    <d2p1:FrequencyType>2</d2p1:FrequencyType>
    <d2p1:RandomMinutesAfter>8</d2p1:RandomMinutesAfter>
    <d2p1:RandomMinutesBefore>7</d2p1:RandomMinutesBefore>
    <d2p1:ScheduleDate>sample string 3</d2p1:ScheduleDate>
    <d2p1:SmartActionScheduleID>1</d2p1:SmartActionScheduleID>
    <d2p1:StartTime>sample string 4</d2p1:StartTime>
    <d2p1:Sunrise>5</d2p1:Sunrise>
    <d2p1:Sunset>6</d2p1:Sunset>
  </Schedule>
  <SecuritySubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:SecuritySubAction>
      <d2p1:ByPassZones xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ByPassZones>
      <d2p1:SecuritySystemID>2</d2p1:SecuritySystemID>
      <d2p1:State>3</d2p1:State>
      <d2p1:SubActionID>1</d2p1:SubActionID>
    </d2p1:SecuritySubAction>
    <d2p1:SecuritySubAction>
      <d2p1:ByPassZones xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ByPassZones>
      <d2p1:SecuritySystemID>2</d2p1:SecuritySystemID>
      <d2p1:State>3</d2p1:State>
      <d2p1:SubActionID>1</d2p1:SubActionID>
    </d2p1:SecuritySubAction>
  </SecuritySubActions>
  <SwitchSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:SwitchSubAction>
      <d2p1:DeviceDuration>6</d2p1:DeviceDuration>
      <d2p1:Level>5</d2p1:Level>
      <d2p1:State>4</d2p1:State>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:SwitchID>3</d2p1:SwitchID>
      <d2p1:SwitchType>2</d2p1:SwitchType>
    </d2p1:SwitchSubAction>
    <d2p1:SwitchSubAction>
      <d2p1:DeviceDuration>6</d2p1:DeviceDuration>
      <d2p1:Level>5</d2p1:Level>
      <d2p1:State>4</d2p1:State>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:SwitchID>3</d2p1:SwitchID>
      <d2p1:SwitchType>2</d2p1:SwitchType>
    </d2p1:SwitchSubAction>
  </SwitchSubActions>
  <ThermostatSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:ThermostatSubAction>
      <d2p1:CoolSetPoint>6</d2p1:CoolSetPoint>
      <d2p1:FanMode>4</d2p1:FanMode>
      <d2p1:HeatSetPoint>5</d2p1:HeatSetPoint>
      <d2p1:Mode>3</d2p1:Mode>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:ThermostatID>2</d2p1:ThermostatID>
    </d2p1:ThermostatSubAction>
    <d2p1:ThermostatSubAction>
      <d2p1:CoolSetPoint>6</d2p1:CoolSetPoint>
      <d2p1:FanMode>4</d2p1:FanMode>
      <d2p1:HeatSetPoint>5</d2p1:HeatSetPoint>
      <d2p1:Mode>3</d2p1:Mode>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:ThermostatID>2</d2p1:ThermostatID>
    </d2p1:ThermostatSubAction>
  </ThermostatSubActions>
  <TriggerEvent xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:DeviceID>4</d2p1:DeviceID>
    <d2p1:DeviceState>8</d2p1:DeviceState>
    <d2p1:SecurityTriggerDeviceID>3</d2p1:SecurityTriggerDeviceID>
    <d2p1:SecurityTriggerEvent>2</d2p1:SecurityTriggerEvent>
    <d2p1:SmartActionTriggerEventID>1</d2p1:SmartActionTriggerEventID>
    <d2p1:TriggerEventType>7</d2p1:TriggerEventType>
    <d2p1:TriggerZoneID>5</d2p1:TriggerZoneID>
    <d2p1:TriggerZoneType>6</d2p1:TriggerZoneType>
  </TriggerEvent>
  <WifiThermostatSubActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:WifiThermostatSubAction>
      <d2p1:CoolSetPoint>6</d2p1:CoolSetPoint>
      <d2p1:FanMode>4</d2p1:FanMode>
      <d2p1:HeatSetPoint>5</d2p1:HeatSetPoint>
      <d2p1:Mode>3</d2p1:Mode>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:WifiThermostatID>2</d2p1:WifiThermostatID>
    </d2p1:WifiThermostatSubAction>
    <d2p1:WifiThermostatSubAction>
      <d2p1:CoolSetPoint>6</d2p1:CoolSetPoint>
      <d2p1:FanMode>4</d2p1:FanMode>
      <d2p1:HeatSetPoint>5</d2p1:HeatSetPoint>
      <d2p1:Mode>3</d2p1:Mode>
      <d2p1:SubActionID>1</d2p1:SubActionID>
      <d2p1:WifiThermostatID>2</d2p1:WifiThermostatID>
    </d2p1:WifiThermostatSubAction>
  </WifiThermostatSubActions>
  <Created>2025-04-01T23:48:17.2889201-04:00</Created>
  <IsSmartActionSceneEnabled>true</IsSmartActionSceneEnabled>
  <LocationID>3</LocationID>
  <Name>sample string 4</Name>
  <SmartActionSceneID>1</SmartActionSceneID>
  <SmartActionSceneIconID>9</SmartActionSceneIconID>
  <SmartActionSceneIndex>2</SmartActionSceneIndex>
  <State>7</State>
  <SyncStatus>8</SyncStatus>
  <TriggerType>5</TriggerType>
</ActionSceneInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResults

Name	Description	Type	Additional 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>