GET api/Addresses/{id}

Get address including floors, rooms, and areas.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

Address
NameDescriptionTypeAdditional information
ID

string

None.

Name

string

None.

ZenseHomeBoxID

string

None.

OwnerEmail

string

None.

UserEmails

Collection of string

None.

UserEmailsSQL

string

None.

Floors

Collection of Floor

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "sample string 1",
  "Name": "sample string 2",
  "ZenseHomeBoxID": "sample string 3",
  "OwnerEmail": "sample string 4",
  "UserEmails": [
    "sample string 5"
  ],
  "UserEmailsSQL": "sample string 5",
  "Floors": [
    {
      "ID": "sample string 1",
      "AddressID": "sample string 2",
      "Name": "sample string 3",
      "Rooms": [
        null,
        {
          "ID": "sample string 1",
          "FloorID": "sample string 2",
          "Name": "sample string 3",
          "Areas": [
            null,
            {
              "ID": "sample string 1",
              "RoomID": "sample string 2",
              "Name": "sample string 3",
              "UnitIDs": [
                1,
                2
              ],
              "UnitIDsSQL": "1;2",
              "Buttons": null,
              "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
            }
          ],
          "UnitIDs": [
            1,
            2
          ],
          "UnitIDsSQL": "1;2",
          "Buttons": null,
          "ButtonsSQL": "",
          "ButtonsToDelete": null,
          "DimmerButtons": null,
          "DimmerButtonsSQL": "",
          "PIRs": null,
          "PIRsSQL": "",
          "PIRsToDelete": null,
          "AutoOffTime": "00:00:00",
          "AutoOffTimeSQL": 0,
          "DimEnabled": false,
          "LeadingEdge": false,
          "AutoOffPIREnabled": false,
          "DimmerLevel": 0,
          "AutoOffMasterPIR": 0,
          "AutoOffMasterPIRToDelete": 0
        }
      ]
    },
    {
      "ID": "sample string 1",
      "AddressID": "sample string 2",
      "Name": "sample string 3",
      "Rooms": [
        null,
        {
          "ID": "sample string 1",
          "FloorID": "sample string 2",
          "Name": "sample string 3",
          "Areas": [
            null,
            {
              "ID": "sample string 1",
              "RoomID": "sample string 2",
              "Name": "sample string 3",
              "UnitIDs": [
                1,
                2
              ],
              "UnitIDsSQL": "1;2",
              "Buttons": null,
              "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
            }
          ],
          "UnitIDs": [
            1,
            2
          ],
          "UnitIDsSQL": "1;2",
          "Buttons": null,
          "ButtonsSQL": "",
          "ButtonsToDelete": null,
          "DimmerButtons": null,
          "DimmerButtonsSQL": "",
          "PIRs": null,
          "PIRsSQL": "",
          "PIRsToDelete": null,
          "AutoOffTime": "00:00:00",
          "AutoOffTimeSQL": 0,
          "DimEnabled": false,
          "LeadingEdge": false,
          "AutoOffPIREnabled": false,
          "DimmerLevel": 0,
          "AutoOffMasterPIR": 0,
          "AutoOffMasterPIRToDelete": 0
        }
      ]
    }
  ]
}

text/html

Sample:
{"ID":"sample string 1","Name":"sample string 2","ZenseHomeBoxID":"sample string 3","OwnerEmail":"sample string 4","UserEmails":["sample string 5"],"UserEmailsSQL":"sample string 5","Floors":[{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Rooms":[null,{"ID":"sample string 1","FloorID":"sample string 2","Name":"sample string 3","Areas":[null,{"ID":"sample string 1","RoomID":"sample string 2","Name":"sample string 3","UnitIDs":[1,2],"UnitIDsSQL":"1;2","Buttons":null,"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}],"UnitIDs":[1,2],"UnitIDsSQL":"1;2","Buttons":null,"ButtonsSQL":"","ButtonsToDelete":null,"DimmerButtons":null,"DimmerButtonsSQL":"","PIRs":null,"PIRsSQL":"","PIRsToDelete":null,"AutoOffTime":"00:00:00","AutoOffTimeSQL":0,"DimEnabled":false,"LeadingEdge":false,"AutoOffPIREnabled":false,"DimmerLevel":0,"AutoOffMasterPIR":0,"AutoOffMasterPIRToDelete":0}]},{"ID":"sample string 1","AddressID":"sample string 2","Name":"sample string 3","Rooms":[null,{"ID":"sample string 1","FloorID":"sample string 2","Name":"sample string 3","Areas":[null,{"ID":"sample string 1","RoomID":"sample string 2","Name":"sample string 3","UnitIDs":[1,2],"UnitIDsSQL":"1;2","Buttons":null,"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}],"UnitIDs":[1,2],"UnitIDsSQL":"1;2","Buttons":null,"ButtonsSQL":"","ButtonsToDelete":null,"DimmerButtons":null,"DimmerButtonsSQL":"","PIRs":null,"PIRsSQL":"","PIRsToDelete":null,"AutoOffTime":"00:00:00","AutoOffTimeSQL":0,"DimEnabled":false,"LeadingEdge":false,"AutoOffPIREnabled":false,"DimmerLevel":0,"AutoOffMasterPIR":0,"AutoOffMasterPIRToDelete":0}]}]}

application/xml, text/xml

Sample:
<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZPPModel.Model">
  <Floors>
    <Floor>
      <AddressID>sample string 2</AddressID>
      <ID>sample string 1</ID>
      <Name>sample string 3</Name>
      <Rooms>
        <Room i:nil="true" />
        <Room>
          <Areas>
            <Area i:nil="true" />
            <Area>
              <AutoOffMasterPIR>0</AutoOffMasterPIR>
              <AutoOffMasterPIRToDelete>0</AutoOffMasterPIRToDelete>
              <AutoOffPIREnabled>false</AutoOffPIREnabled>
              <AutoOffTime>PT0S</AutoOffTime>
              <AutoOffTimeSQL>0</AutoOffTimeSQL>
              <Buttons i:nil="true" />
              <ButtonsSQL></ButtonsSQL>
              <ButtonsToDelete i:nil="true" />
              <DimEnabled>false</DimEnabled>
              <DimmerButtons i:nil="true" />
              <DimmerButtonsSQL></DimmerButtonsSQL>
              <DimmerLevel>0</DimmerLevel>
              <ID>sample string 1</ID>
              <LeadingEdge>false</LeadingEdge>
              <Name>sample string 3</Name>
              <PIRs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
              <PIRsSQL></PIRsSQL>
              <PIRsToDelete xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
              <RoomID>sample string 2</RoomID>
              <UnitIDs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </UnitIDs>
              <UnitIDsSQL>1;2</UnitIDsSQL>
            </Area>
          </Areas>
          <AutoOffMasterPIR>0</AutoOffMasterPIR>
          <AutoOffMasterPIRToDelete>0</AutoOffMasterPIRToDelete>
          <AutoOffPIREnabled>false</AutoOffPIREnabled>
          <AutoOffTime>PT0S</AutoOffTime>
          <AutoOffTimeSQL>0</AutoOffTimeSQL>
          <Buttons i:nil="true" />
          <ButtonsSQL></ButtonsSQL>
          <ButtonsToDelete i:nil="true" />
          <DimEnabled>false</DimEnabled>
          <DimmerButtons i:nil="true" />
          <DimmerButtonsSQL></DimmerButtonsSQL>
          <DimmerLevel>0</DimmerLevel>
          <FloorID>sample string 2</FloorID>
          <ID>sample string 1</ID>
          <LeadingEdge>false</LeadingEdge>
          <Name>sample string 3</Name>
          <PIRs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
          <PIRsSQL></PIRsSQL>
          <PIRsToDelete xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
          <UnitIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </UnitIDs>
          <UnitIDsSQL>1;2</UnitIDsSQL>
        </Room>
      </Rooms>
    </Floor>
    <Floor>
      <AddressID>sample string 2</AddressID>
      <ID>sample string 1</ID>
      <Name>sample string 3</Name>
      <Rooms>
        <Room i:nil="true" />
        <Room>
          <Areas>
            <Area i:nil="true" />
            <Area>
              <AutoOffMasterPIR>0</AutoOffMasterPIR>
              <AutoOffMasterPIRToDelete>0</AutoOffMasterPIRToDelete>
              <AutoOffPIREnabled>false</AutoOffPIREnabled>
              <AutoOffTime>PT0S</AutoOffTime>
              <AutoOffTimeSQL>0</AutoOffTimeSQL>
              <Buttons i:nil="true" />
              <ButtonsSQL></ButtonsSQL>
              <ButtonsToDelete i:nil="true" />
              <DimEnabled>false</DimEnabled>
              <DimmerButtons i:nil="true" />
              <DimmerButtonsSQL></DimmerButtonsSQL>
              <DimmerLevel>0</DimmerLevel>
              <ID>sample string 1</ID>
              <LeadingEdge>false</LeadingEdge>
              <Name>sample string 3</Name>
              <PIRs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
              <PIRsSQL></PIRsSQL>
              <PIRsToDelete xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
              <RoomID>sample string 2</RoomID>
              <UnitIDs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>1</d8p1:int>
                <d8p1:int>2</d8p1:int>
              </UnitIDs>
              <UnitIDsSQL>1;2</UnitIDsSQL>
            </Area>
          </Areas>
          <AutoOffMasterPIR>0</AutoOffMasterPIR>
          <AutoOffMasterPIRToDelete>0</AutoOffMasterPIRToDelete>
          <AutoOffPIREnabled>false</AutoOffPIREnabled>
          <AutoOffTime>PT0S</AutoOffTime>
          <AutoOffTimeSQL>0</AutoOffTimeSQL>
          <Buttons i:nil="true" />
          <ButtonsSQL></ButtonsSQL>
          <ButtonsToDelete i:nil="true" />
          <DimEnabled>false</DimEnabled>
          <DimmerButtons i:nil="true" />
          <DimmerButtonsSQL></DimmerButtonsSQL>
          <DimmerLevel>0</DimmerLevel>
          <FloorID>sample string 2</FloorID>
          <ID>sample string 1</ID>
          <LeadingEdge>false</LeadingEdge>
          <Name>sample string 3</Name>
          <PIRs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
          <PIRsSQL></PIRsSQL>
          <PIRsToDelete xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
          <UnitIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </UnitIDs>
          <UnitIDsSQL>1;2</UnitIDsSQL>
        </Room>
      </Rooms>
    </Floor>
  </Floors>
  <ID>sample string 1</ID>
  <Name>sample string 2</Name>
  <OwnerEmail>sample string 4</OwnerEmail>
  <UserEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 5</d2p1:string>
  </UserEmails>
  <UserEmailsSQL>sample string 5</UserEmailsSQL>
  <ZenseHomeBoxID>sample string 3</ZenseHomeBoxID>
</Address>