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

To add or Edit the Smart Action

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	location	integer	Required

Body Parameters

SmartAction

Name	Type	Additional information
SmartActionID	integer	None.
SmartActionIndex	integer	None.
Name	string	None.
TriggerType	integer	None.
Created	date	None.
State	integer	None.
SyncStatus	integer	None.
SmartActionIconId	integer	None.
SmartActionOrigin	integer	None.
PartitionId	integer	None.
SwitchSubActions	Collection of SwitchSubAction	None.
LockSubActions	Collection of LockSubAction	None.
ThermostatSubActions	Collection of ThermostatSubAction	None.
WifiThermostatSubActions	Collection of WifiThermostatSubAction	None.
CameraSubActions	Collection of CameraSubAction	None.
SecuritySubActions	Collection of SecuritySubAction	None.
TriggerEvent	SmartActionTriggerEvent	None.
Schedule	SmartActionSchedule	None.
SmartActionSensors	Collection of SmartActionSensor	None.
GeoFenceTriggerType	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SmartActionID": 1,
  "SmartActionIndex": 2,
  "Name": "sample string 4",
  "TriggerType": 5,
  "Created": "2025-04-01T23:49:58.1304742-04:00",
  "State": 7,
  "SyncStatus": 8,
  "SmartActionIconId": 9,
  "SmartActionOrigin": 10,
  "PartitionId": 11,
  "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
    }
  ],
  "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
    }
  ],
  "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
  },
  "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
  },
  "SmartActionSensors": [
    {
      "SmartActionSensorID": 1,
      "SmartActionID": 2,
      "SensorID": 3,
      "ZoneID": 4,
      "ZoneDescription": "sample string 5",
      "SensorAction": 64,
      "DeviceDuration": 7
    },
    {
      "SmartActionSensorID": 1,
      "SmartActionID": 2,
      "SensorID": 3,
      "ZoneID": 4,
      "ZoneDescription": "sample string 5",
      "SensorAction": 64,
      "DeviceDuration": 7
    }
  ],
  "GeoFenceTriggerType": 12
}

application/xml, text/xml

Sample:

<SmartAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
  <CameraSubActions>
    <CameraSubAction>
      <Action>4</Action>
      <DeviceID>2</DeviceID>
      <SubActionID>1</SubActionID>
      <Type>3</Type>
      <ZoneID>5</ZoneID>
    </CameraSubAction>
    <CameraSubAction>
      <Action>4</Action>
      <DeviceID>2</DeviceID>
      <SubActionID>1</SubActionID>
      <Type>3</Type>
      <ZoneID>5</ZoneID>
    </CameraSubAction>
  </CameraSubActions>
  <GeoFenceTriggerType>12</GeoFenceTriggerType>
  <LockSubActions>
    <LockSubAction>
      <AuthorizationCode>4</AuthorizationCode>
      <LockID>2</LockID>
      <State>3</State>
      <SubActionID>1</SubActionID>
    </LockSubAction>
    <LockSubAction>
      <AuthorizationCode>4</AuthorizationCode>
      <LockID>2</LockID>
      <State>3</State>
      <SubActionID>1</SubActionID>
    </LockSubAction>
  </LockSubActions>
  <Schedule>
    <DayOfMonth xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DayOfMonth>
    <DayOfWeek xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DayOfWeek>
    <FrequencyType>2</FrequencyType>
    <RandomMinutesAfter>8</RandomMinutesAfter>
    <RandomMinutesBefore>7</RandomMinutesBefore>
    <ScheduleDate>sample string 3</ScheduleDate>
    <SmartActionScheduleID>1</SmartActionScheduleID>
    <StartTime>sample string 4</StartTime>
    <Sunrise>5</Sunrise>
    <Sunset>6</Sunset>
  </Schedule>
  <SecuritySubActions>
    <SecuritySubAction>
      <ByPassZones xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ByPassZones>
      <SecuritySystemID>2</SecuritySystemID>
      <State>3</State>
      <SubActionID>1</SubActionID>
    </SecuritySubAction>
    <SecuritySubAction>
      <ByPassZones xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ByPassZones>
      <SecuritySystemID>2</SecuritySystemID>
      <State>3</State>
      <SubActionID>1</SubActionID>
    </SecuritySubAction>
  </SecuritySubActions>
  <SmartActionSensors>
    <SmartActionSensor>
      <DeviceDuration>7</DeviceDuration>
      <SensorAction>64</SensorAction>
      <SensorID>3</SensorID>
      <SmartActionID>2</SmartActionID>
      <SmartActionSensorID>1</SmartActionSensorID>
      <ZoneDescription>sample string 5</ZoneDescription>
      <ZoneID>4</ZoneID>
    </SmartActionSensor>
    <SmartActionSensor>
      <DeviceDuration>7</DeviceDuration>
      <SensorAction>64</SensorAction>
      <SensorID>3</SensorID>
      <SmartActionID>2</SmartActionID>
      <SmartActionSensorID>1</SmartActionSensorID>
      <ZoneDescription>sample string 5</ZoneDescription>
      <ZoneID>4</ZoneID>
    </SmartActionSensor>
  </SmartActionSensors>
  <SwitchSubActions>
    <SwitchSubAction>
      <DeviceDuration>6</DeviceDuration>
      <Level>5</Level>
      <State>4</State>
      <SubActionID>1</SubActionID>
      <SwitchID>3</SwitchID>
      <SwitchType>2</SwitchType>
    </SwitchSubAction>
    <SwitchSubAction>
      <DeviceDuration>6</DeviceDuration>
      <Level>5</Level>
      <State>4</State>
      <SubActionID>1</SubActionID>
      <SwitchID>3</SwitchID>
      <SwitchType>2</SwitchType>
    </SwitchSubAction>
  </SwitchSubActions>
  <ThermostatSubActions>
    <ThermostatSubAction>
      <CoolSetPoint>6</CoolSetPoint>
      <FanMode>4</FanMode>
      <HeatSetPoint>5</HeatSetPoint>
      <Mode>3</Mode>
      <SubActionID>1</SubActionID>
      <ThermostatID>2</ThermostatID>
    </ThermostatSubAction>
    <ThermostatSubAction>
      <CoolSetPoint>6</CoolSetPoint>
      <FanMode>4</FanMode>
      <HeatSetPoint>5</HeatSetPoint>
      <Mode>3</Mode>
      <SubActionID>1</SubActionID>
      <ThermostatID>2</ThermostatID>
    </ThermostatSubAction>
  </ThermostatSubActions>
  <TriggerEvent>
    <DeviceID>4</DeviceID>
    <DeviceState>8</DeviceState>
    <SecurityTriggerDeviceID>3</SecurityTriggerDeviceID>
    <SecurityTriggerEvent>2</SecurityTriggerEvent>
    <SmartActionTriggerEventID>1</SmartActionTriggerEventID>
    <TriggerEventType>7</TriggerEventType>
    <TriggerZoneID>5</TriggerZoneID>
    <TriggerZoneType>6</TriggerZoneType>
  </TriggerEvent>
  <WifiThermostatSubActions>
    <WifiThermostatSubAction>
      <CoolSetPoint>6</CoolSetPoint>
      <FanMode>4</FanMode>
      <HeatSetPoint>5</HeatSetPoint>
      <Mode>3</Mode>
      <SubActionID>1</SubActionID>
      <WifiThermostatID>2</WifiThermostatID>
    </WifiThermostatSubAction>
    <WifiThermostatSubAction>
      <CoolSetPoint>6</CoolSetPoint>
      <FanMode>4</FanMode>
      <HeatSetPoint>5</HeatSetPoint>
      <Mode>3</Mode>
      <SubActionID>1</SubActionID>
      <WifiThermostatID>2</WifiThermostatID>
    </WifiThermostatSubAction>
  </WifiThermostatSubActions>
  <Created>2025-04-01T23:49:58.1304742-04:00</Created>
  <LocationID>3</LocationID>
  <Name>sample string 4</Name>
  <PartitionId>11</PartitionId>
  <SmartActionID>1</SmartActionID>
  <SmartActionIconId>9</SmartActionIconId>
  <SmartActionIndex>2</SmartActionIndex>
  <SmartActionOrigin>10</SmartActionOrigin>
  <State>7</State>
  <SyncStatus>8</SyncStatus>
  <TriggerType>5</TriggerType>
</SmartAction>

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>