GET api/locations/{locationId}/AutomationDevice/Scenes/{deviceId}

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required
deviceId		integer	Required

Body Parameters

None.

Response Information

Resource Description

SceneResults

Name	Description	Type	Additional information
Scene			None.

Response Formats

application/json, text/json

Sample:

{
  "Scene": [
    {
      "sceneID": 1,
      "name": "sample string 2",
      "TriggerType": 3,
      "state": "Disabled",
      "switchSubActions": [
        {
          "name": "sample string 3",
          "type": "Sprinkler",
          "state": "Unknown",
          "level": 7
        },
        {
          "name": "sample string 3",
          "type": "Sprinkler",
          "state": "Unknown",
          "level": 7
        }
      ],
      "lockSubActions": [
        {
          "lockName": "sample string 1",
          "state": "doorunlock"
        },
        {
          "lockName": "sample string 1",
          "state": "doorunlock"
        }
      ],
      "thermostatSubActions": [
        {
          "thermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "mode": "off",
          "fanMode": "auto"
        },
        {
          "thermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "mode": "off",
          "fanMode": "auto"
        }
      ],
      "wifiThermostatSubActions": [
        {
          "wifiThermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "currentOpMode": "normal",
          "mode": "off",
          "fanMode": "auto"
        },
        {
          "wifiThermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "currentOpMode": "normal",
          "mode": "off",
          "fanMode": "auto"
        }
      ],
      "securitySubActions": [
        {
          "state": "Disarm"
        },
        {
          "state": "Disarm"
        }
      ],
      "triggerEvent": {
        "securityTriggerEvent": "ArmStay",
        "deviceDescription": "sample string 1",
        "ZoneDescription": "sample string 2",
        "deviceState": "sample string 3"
      },
      "schedule": {
        "frequencyType": "Once",
        "scheduleDate": "sample string 1",
        "dayOfWeek": [
          "sample string 1",
          "sample string 2"
        ],
        "randomMinutesBefore": true,
        "randomMinutesAfter": true,
        "triggerTime": "sample string 4"
      }
    },
    {
      "sceneID": 1,
      "name": "sample string 2",
      "TriggerType": 3,
      "state": "Disabled",
      "switchSubActions": [
        {
          "name": "sample string 3",
          "type": "Sprinkler",
          "state": "Unknown",
          "level": 7
        },
        {
          "name": "sample string 3",
          "type": "Sprinkler",
          "state": "Unknown",
          "level": 7
        }
      ],
      "lockSubActions": [
        {
          "lockName": "sample string 1",
          "state": "doorunlock"
        },
        {
          "lockName": "sample string 1",
          "state": "doorunlock"
        }
      ],
      "thermostatSubActions": [
        {
          "thermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "mode": "off",
          "fanMode": "auto"
        },
        {
          "thermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "mode": "off",
          "fanMode": "auto"
        }
      ],
      "wifiThermostatSubActions": [
        {
          "wifiThermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "currentOpMode": "normal",
          "mode": "off",
          "fanMode": "auto"
        },
        {
          "wifiThermostatName": "sample string 1",
          "heatSetPoint": 2,
          "coolSetPoint": 3,
          "currentOpMode": "normal",
          "mode": "off",
          "fanMode": "auto"
        }
      ],
      "securitySubActions": [
        {
          "state": "Disarm"
        },
        {
          "state": "Disarm"
        }
      ],
      "triggerEvent": {
        "securityTriggerEvent": "ArmStay",
        "deviceDescription": "sample string 1",
        "ZoneDescription": "sample string 2",
        "deviceState": "sample string 3"
      },
      "schedule": {
        "frequencyType": "Once",
        "scheduleDate": "sample string 1",
        "dayOfWeek": [
          "sample string 1",
          "sample string 2"
        ],
        "randomMinutesBefore": true,
        "randomMinutesAfter": true,
        "triggerTime": "sample string 4"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<SceneResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <Scene>
    <Scene>
      <lockSubActions>
        <LockSubAction>
          <lockName>sample string 1</lockName>
          <state>doorunlock</state>
        </LockSubAction>
        <LockSubAction>
          <lockName>sample string 1</lockName>
          <state>doorunlock</state>
        </LockSubAction>
      </lockSubActions>
      <schedule>
        <dayOfWeek xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </dayOfWeek>
        <frequencyType>Once</frequencyType>
        <randomMinutesAfter>true</randomMinutesAfter>
        <randomMinutesBefore>true</randomMinutesBefore>
        <scheduleDate>sample string 1</scheduleDate>
        <triggerTime>sample string 4</triggerTime>
      </schedule>
      <securitySubActions>
        <SecuritySubAction>
          <state>Disarm</state>
        </SecuritySubAction>
        <SecuritySubAction>
          <state>Disarm</state>
        </SecuritySubAction>
      </securitySubActions>
      <switchSubActions>
        <SwitchSubAction>
          <DeviceID>1</DeviceID>
          <SwitchIndex>4</SwitchIndex>
          <deviceStatusId>64</deviceStatusId>
          <iconId>8</iconId>
          <id>2</id>
          <level>7</level>
          <name>sample string 3</name>
          <stateID>6</stateID>
          <typeID>5</typeID>
        </SwitchSubAction>
        <SwitchSubAction>
          <DeviceID>1</DeviceID>
          <SwitchIndex>4</SwitchIndex>
          <deviceStatusId>64</deviceStatusId>
          <iconId>8</iconId>
          <id>2</id>
          <level>7</level>
          <name>sample string 3</name>
          <stateID>6</stateID>
          <typeID>5</typeID>
        </SwitchSubAction>
      </switchSubActions>
      <thermostatSubActions>
        <ThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <thermostatName>sample string 1</thermostatName>
        </ThermostatSubAction>
        <ThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <thermostatName>sample string 1</thermostatName>
        </ThermostatSubAction>
      </thermostatSubActions>
      <triggerEvent>
        <ZoneDescription>sample string 2</ZoneDescription>
        <deviceDescription>sample string 1</deviceDescription>
        <deviceState>sample string 3</deviceState>
        <securityTriggerEvent>ArmStay</securityTriggerEvent>
      </triggerEvent>
      <wifiThermostatSubActions>
        <WifiThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <wifiThermostatName>sample string 1</wifiThermostatName>
        </WifiThermostatSubAction>
        <WifiThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <wifiThermostatName>sample string 1</wifiThermostatName>
        </WifiThermostatSubAction>
      </wifiThermostatSubActions>
      <TriggerType>3</TriggerType>
      <name>sample string 2</name>
      <sceneID>1</sceneID>
      <state>Disabled</state>
      <triggerType>Anytime</triggerType>
    </Scene>
    <Scene>
      <lockSubActions>
        <LockSubAction>
          <lockName>sample string 1</lockName>
          <state>doorunlock</state>
        </LockSubAction>
        <LockSubAction>
          <lockName>sample string 1</lockName>
          <state>doorunlock</state>
        </LockSubAction>
      </lockSubActions>
      <schedule>
        <dayOfWeek xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </dayOfWeek>
        <frequencyType>Once</frequencyType>
        <randomMinutesAfter>true</randomMinutesAfter>
        <randomMinutesBefore>true</randomMinutesBefore>
        <scheduleDate>sample string 1</scheduleDate>
        <triggerTime>sample string 4</triggerTime>
      </schedule>
      <securitySubActions>
        <SecuritySubAction>
          <state>Disarm</state>
        </SecuritySubAction>
        <SecuritySubAction>
          <state>Disarm</state>
        </SecuritySubAction>
      </securitySubActions>
      <switchSubActions>
        <SwitchSubAction>
          <DeviceID>1</DeviceID>
          <SwitchIndex>4</SwitchIndex>
          <deviceStatusId>64</deviceStatusId>
          <iconId>8</iconId>
          <id>2</id>
          <level>7</level>
          <name>sample string 3</name>
          <stateID>6</stateID>
          <typeID>5</typeID>
        </SwitchSubAction>
        <SwitchSubAction>
          <DeviceID>1</DeviceID>
          <SwitchIndex>4</SwitchIndex>
          <deviceStatusId>64</deviceStatusId>
          <iconId>8</iconId>
          <id>2</id>
          <level>7</level>
          <name>sample string 3</name>
          <stateID>6</stateID>
          <typeID>5</typeID>
        </SwitchSubAction>
      </switchSubActions>
      <thermostatSubActions>
        <ThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <thermostatName>sample string 1</thermostatName>
        </ThermostatSubAction>
        <ThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <thermostatName>sample string 1</thermostatName>
        </ThermostatSubAction>
      </thermostatSubActions>
      <triggerEvent>
        <ZoneDescription>sample string 2</ZoneDescription>
        <deviceDescription>sample string 1</deviceDescription>
        <deviceState>sample string 3</deviceState>
        <securityTriggerEvent>ArmStay</securityTriggerEvent>
      </triggerEvent>
      <wifiThermostatSubActions>
        <WifiThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <wifiThermostatName>sample string 1</wifiThermostatName>
        </WifiThermostatSubAction>
        <WifiThermostatSubAction>
          <coolSetPoint>3</coolSetPoint>
          <currentOpMode>normal</currentOpMode>
          <fanMode>auto</fanMode>
          <heatSetPoint>2</heatSetPoint>
          <mode>off</mode>
          <wifiThermostatName>sample string 1</wifiThermostatName>
        </WifiThermostatSubAction>
      </wifiThermostatSubActions>
      <TriggerType>3</TriggerType>
      <name>sample string 2</name>
      <sceneID>1</sceneID>
      <state>Disabled</state>
      <triggerType>Anytime</triggerType>
    </Scene>
  </Scene>
</SceneResults>