GET api/v1/locations/{locationId}/AutomationDevice/config/sceneAction

To Get the Smart Action/Scene Configuration

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

locationId

integer

Required

Body Parameters

None.

Response Information

Resource Description

GetSmartSceneActionConfigResults

GetSmartSceneActionConfigResults
NameDescriptionTypeAdditional information
ActionConfig

SmartActionConfiguration

None.

SceneConfig

SmartSceneConfiguration

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ActionConfig": {
    "MaximumSmartActions": 1,
    "MaximumNameLength": 2,
    "MaximumDevicesPerSmartAction": 3,
    "CurrentSmartActionCount": 4,
    "UnicodeNameSupport": true
  },
  "SceneConfig": {
    "MaximumSmartScenes": 1,
    "MaximumDevicesPerScene": 2,
    "CurrentSmartSceneCount": 3
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:
<GetSmartSceneActionConfigResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
  <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>
  <ActionConfig xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartAction">
    <d2p1:CurrentSmartActionCount>4</d2p1:CurrentSmartActionCount>
    <d2p1:IsEnabled>true</d2p1:IsEnabled>
    <d2p1:IsLocked>true</d2p1:IsLocked>
    <d2p1:MaximumDevicesPerSmartAction>3</d2p1:MaximumDevicesPerSmartAction>
    <d2p1:MaximumNameLength>2</d2p1:MaximumNameLength>
    <d2p1:MaximumSmartActions>1</d2p1:MaximumSmartActions>
    <d2p1:UnicodeNameSupport>true</d2p1:UnicodeNameSupport>
  </ActionConfig>
  <SceneConfig xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.SmartScene">
    <d2p1:CurrentSmartSceneCount>3</d2p1:CurrentSmartSceneCount>
    <d2p1:MaximumDevicesPerScene>2</d2p1:MaximumDevicesPerScene>
    <d2p1:MaximumSmartScenes>1</d2p1:MaximumSmartScenes>
  </SceneConfig>
</GetSmartSceneActionConfigResults>