GET api/v1/locations/{locationId}/devices/{deviceId}/automation/switches/{switchId}?AdditionalInput={AdditionalInput}

Get Specific Switch

Request Information

URI Parameters

Name	Description	Type	Additional information
deviceId	Device ID	integer	Required
switchId	Switch ID	integer	Required
AdditionalInput		string	Required
locationId		string	None.

Body Parameters

None.

Response Information

Resource Description

SwitchInfo

Name	Type	Additional information
DeviceID	integer	None.
SwitchID	integer	None.
SwitchName	string	None.
SwitchIndex	integer	None.
SwitchType	integer	None.
SwitchState	integer	None.
SwitchLevel	integer	None.
SwitchIconID	integer	None.
DeviceStatusID	byte	None.
CanRemoteClose	integer	None.
DateTimeUpdated	date	None.
FaultStatusId	integer	None.
EndUserControl	byte	None.
EndUserVisibility	byte	None.

Response Formats

application/json, text/json

Sample:

{
  "DeviceID": 1,
  "SwitchID": 2,
  "SwitchName": "sample string 3",
  "SwitchIndex": 4,
  "SwitchType": 5,
  "SwitchState": 6,
  "SwitchLevel": 7,
  "SwitchIconID": 8,
  "DeviceStatusID": 64,
  "CanRemoteClose": 10,
  "DateTimeUpdated": "2025-04-01T23:56:17.7999384-04:00",
  "FaultStatusId": 12,
  "EndUserControl": 64,
  "EndUserVisibility": 64
}

application/xml, text/xml

Sample:

<SwitchInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <CanRemoteClose>10</CanRemoteClose>
  <DateTimeUpdated>2025-04-01T23:56:17.7999384-04:00</DateTimeUpdated>
  <DeviceID>1</DeviceID>
  <DeviceStatusID>64</DeviceStatusID>
  <EndUserControl>64</EndUserControl>
  <EndUserVisibility>64</EndUserVisibility>
  <FaultStatusId>12</FaultStatusId>
  <SwitchID>2</SwitchID>
  <SwitchIconID>8</SwitchIconID>
  <SwitchIndex>4</SwitchIndex>
  <SwitchLevel>7</SwitchLevel>
  <SwitchName>sample string 3</SwitchName>
  <SwitchState>6</SwitchState>
  <SwitchType>5</SwitchType>
</SwitchInfo>