GET api/AddressUnits/{id}

Gets list of units for an address.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Unit
NameDescriptionTypeAdditional information
ID

integer

None.

AddressID

string

None.

Name

string

None.

FullID

string

None.

Type

UnitType

None.

DoNotTurnOff

boolean

None.

TimeSlots

Collection of Schedule

None.

Buttons

Collection of Button

None.

ButtonsSQL

string

None.

ButtonsToDelete

Collection of Button

None.

DimmerButtons

Collection of Button

None.

DimmerButtonsSQL

string

None.

PIRs

Collection of integer

None.

PIRsSQL

string

None.

PIRsToDelete

Collection of integer

None.

AutoOffTime

time interval

None.

AutoOffTimeSQL

integer

None.

DimEnabled

boolean

None.

DimmerLevel

integer

None.

LeadingEdge

boolean

None.

AutoOffPIREnabled

boolean

None.

AutoOffMasterPIR

integer

None.

AutoOffMasterPIRToDelete

integer

None.

Response Formats

application/json, text/json

Sample:
[
  null,
  {
    "ID": 1,
    "AddressID": "sample string 2",
    "Name": "sample string 3",
    "FullID": "000000001",
    "Type": 0,
    "DoNotTurnOff": true,
    "TimeSlots": [
      {
        "ID": "sample string 1",
        "AddressID": "sample string 2",
        "Name": "sample string 3",
        "Tasks": [
          {
            "ID": "sample string 1",
            "ScheduleID": "sample string 2",
            "StartTime": "00:00:00.1234567",
            "StartTimeAstro": 0,
            "Scenarios": [
              null,
              {
                "ID": "sample string 1",
                "AddressID": "sample string 2",
                "Name": "sample string 3",
                "Actions": [
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  },
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  }
                ],
                "Buttons": [],
                "ButtonsSQL": "",
                "ButtonsToDelete": null
              }
            ]
          },
          {
            "ID": "sample string 1",
            "ScheduleID": "sample string 2",
            "StartTime": "00:00:00.1234567",
            "StartTimeAstro": 0,
            "Scenarios": [
              null,
              {
                "ID": "sample string 1",
                "AddressID": "sample string 2",
                "Name": "sample string 3",
                "Actions": [
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  },
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  }
                ],
                "Buttons": [],
                "ButtonsSQL": "",
                "ButtonsToDelete": null
              }
            ]
          }
        ],
        "Enabled": true
      },
      {
        "ID": "sample string 1",
        "AddressID": "sample string 2",
        "Name": "sample string 3",
        "Tasks": [
          {
            "ID": "sample string 1",
            "ScheduleID": "sample string 2",
            "StartTime": "00:00:00.1234567",
            "StartTimeAstro": 0,
            "Scenarios": [
              null,
              {
                "ID": "sample string 1",
                "AddressID": "sample string 2",
                "Name": "sample string 3",
                "Actions": [
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  },
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  }
                ],
                "Buttons": [],
                "ButtonsSQL": "",
                "ButtonsToDelete": null
              }
            ]
          },
          {
            "ID": "sample string 1",
            "ScheduleID": "sample string 2",
            "StartTime": "00:00:00.1234567",
            "StartTimeAstro": 0,
            "Scenarios": [
              null,
              {
                "ID": "sample string 1",
                "AddressID": "sample string 2",
                "Name": "sample string 3",
                "Actions": [
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  },
                  {
                    "ID": "sample string 1",
                    "ScenarioID": "sample string 2",
                    "FloorID": "sample string 3",
                    "RoomID": "sample string 4",
                    "AreaID": "sample string 5",
                    "UnitID": "sample string 6",
                    "Command": 64
                  }
                ],
                "Buttons": [],
                "ButtonsSQL": "",
                "ButtonsToDelete": null
              }
            ]
          }
        ],
        "Enabled": true
      }
    ],
    "Buttons": [],
    "ButtonsSQL": "",
    "ButtonsToDelete": null,
    "DimmerButtons": null,
    "DimmerButtonsSQL": "",
    "PIRs": null,
    "PIRsSQL": "",
    "PIRsToDelete": null,
    "AutoOffTime": "00:00:00",
    "AutoOffTimeSQL": 0,
    "DimEnabled": false,
    "DimmerLevel": 0,
    "LeadingEdge": false,
    "AutoOffPIREnabled": false,
    "AutoOffMasterPIR": 0,
    "AutoOffMasterPIRToDelete": 0
  }
]

text/html

Sample:
[null,{"ID":1,"AddressID":"sample string 2","Name":"sample string 3","FullID":"000000001","Type":0,"DoNotTurnOff":true,"TimeSlots":[{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Tasks":[{"ID":"sample string 1","ScheduleID":"sample string 2","StartTime":"00:00:00.1234567","StartTimeAstro":0,"Scenarios":[null,{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Actions":[{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64},{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64}],"Buttons":[],"ButtonsSQL":"","ButtonsToDelete":null}]},{"ID":"sample string 1","ScheduleID":"sample string 2","StartTime":"00:00:00.1234567","StartTimeAstro":0,"Scenarios":[null,{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Actions":[{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64},{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64}],"Buttons":[],"ButtonsSQL":"","ButtonsToDelete":null}]}],"Enabled":true},{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Tasks":[{"ID":"sample string 1","ScheduleID":"sample string 2","StartTime":"00:00:00.1234567","StartTimeAstro":0,"Scenarios":[null,{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Actions":[{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64},{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64}],"Buttons":[],"ButtonsSQL":"","ButtonsToDelete":null}]},{"ID":"sample string 1","ScheduleID":"sample string 2","StartTime":"00:00:00.1234567","StartTimeAstro":0,"Scenarios":[null,{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Actions":[{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64},{"ID":"sample string 1","ScenarioID":"sample string 2","FloorID":"sample string 3","RoomID":"sample string 4","AreaID":"sample string 5","UnitID":"sample string 6","Command":64}],"Buttons":[],"ButtonsSQL":"","ButtonsToDelete":null}]}],"Enabled":true}],"Buttons":[],"ButtonsSQL":"","ButtonsToDelete":null,"DimmerButtons":null,"DimmerButtonsSQL":"","PIRs":null,"PIRsSQL":"","PIRsToDelete":null,"AutoOffTime":"00:00:00","AutoOffTimeSQL":0,"DimEnabled":false,"DimmerLevel":0,"LeadingEdge":false,"AutoOffPIREnabled":false,"AutoOffMasterPIR":0,"AutoOffMasterPIRToDelete":0}]

application/xml, text/xml

Sample:
<ArrayOfUnit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZPPModel.Model">
  <Unit i:nil="true" />
  <Unit>
    <AddressID>sample string 2</AddressID>
    <AutoOffMasterPIR>0</AutoOffMasterPIR>
    <AutoOffMasterPIRToDelete>0</AutoOffMasterPIRToDelete>
    <AutoOffPIREnabled>false</AutoOffPIREnabled>
    <AutoOffTime>PT0S</AutoOffTime>
    <AutoOffTimeSQL>0</AutoOffTimeSQL>
    <Buttons />
    <ButtonsSQL></ButtonsSQL>
    <ButtonsToDelete i:nil="true" />
    <DimEnabled>false</DimEnabled>
    <DimmerButtons i:nil="true" />
    <DimmerButtonsSQL></DimmerButtonsSQL>
    <DimmerLevel>0</DimmerLevel>
    <DoNotTurnOff>true</DoNotTurnOff>
    <ID>1</ID>
    <LeadingEdge>false</LeadingEdge>
    <Name>sample string 3</Name>
    <PIRs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <PIRsSQL></PIRsSQL>
    <PIRsToDelete xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <TimeSlots>
      <Schedule>
        <AddressID>sample string 2</AddressID>
        <Enabled>true</Enabled>
        <ID>sample string 1</ID>
        <Name>sample string 3</Name>
        <Tasks>
          <ScheduledTask>
            <ID>sample string 1</ID>
            <Scenarios>
              <Scenario i:nil="true" />
              <Scenario>
                <Actions>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                </Actions>
                <AddressID>sample string 2</AddressID>
                <Buttons />
                <ButtonsSQL></ButtonsSQL>
                <ButtonsToDelete i:nil="true" />
                <ID>sample string 1</ID>
                <Name>sample string 3</Name>
              </Scenario>
            </Scenarios>
            <ScheduleID>sample string 2</ScheduleID>
            <StartTime>PT0.1234567S</StartTime>
            <StartTimeAstro>None</StartTimeAstro>
          </ScheduledTask>
          <ScheduledTask>
            <ID>sample string 1</ID>
            <Scenarios>
              <Scenario i:nil="true" />
              <Scenario>
                <Actions>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                </Actions>
                <AddressID>sample string 2</AddressID>
                <Buttons />
                <ButtonsSQL></ButtonsSQL>
                <ButtonsToDelete i:nil="true" />
                <ID>sample string 1</ID>
                <Name>sample string 3</Name>
              </Scenario>
            </Scenarios>
            <ScheduleID>sample string 2</ScheduleID>
            <StartTime>PT0.1234567S</StartTime>
            <StartTimeAstro>None</StartTimeAstro>
          </ScheduledTask>
        </Tasks>
      </Schedule>
      <Schedule>
        <AddressID>sample string 2</AddressID>
        <Enabled>true</Enabled>
        <ID>sample string 1</ID>
        <Name>sample string 3</Name>
        <Tasks>
          <ScheduledTask>
            <ID>sample string 1</ID>
            <Scenarios>
              <Scenario i:nil="true" />
              <Scenario>
                <Actions>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                </Actions>
                <AddressID>sample string 2</AddressID>
                <Buttons />
                <ButtonsSQL></ButtonsSQL>
                <ButtonsToDelete i:nil="true" />
                <ID>sample string 1</ID>
                <Name>sample string 3</Name>
              </Scenario>
            </Scenarios>
            <ScheduleID>sample string 2</ScheduleID>
            <StartTime>PT0.1234567S</StartTime>
            <StartTimeAstro>None</StartTimeAstro>
          </ScheduledTask>
          <ScheduledTask>
            <ID>sample string 1</ID>
            <Scenarios>
              <Scenario i:nil="true" />
              <Scenario>
                <Actions>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                  <ScenarioAction>
                    <AreaID>sample string 5</AreaID>
                    <Command>64</Command>
                    <FloorID>sample string 3</FloorID>
                    <ID>sample string 1</ID>
                    <RoomID>sample string 4</RoomID>
                    <ScenarioID>sample string 2</ScenarioID>
                    <UnitID>sample string 6</UnitID>
                  </ScenarioAction>
                </Actions>
                <AddressID>sample string 2</AddressID>
                <Buttons />
                <ButtonsSQL></ButtonsSQL>
                <ButtonsToDelete i:nil="true" />
                <ID>sample string 1</ID>
                <Name>sample string 3</Name>
              </Scenario>
            </Scenarios>
            <ScheduleID>sample string 2</ScheduleID>
            <StartTime>PT0.1234567S</StartTime>
            <StartTimeAstro>None</StartTimeAstro>
          </ScheduledTask>
        </Tasks>
      </Schedule>
    </TimeSlots>
    <Type>ButtonPanel</Type>
  </Unit>
</ArrayOfUnit>