GET api/AddressScenarios/{id}

Gets list of scenarios for an address.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Scenario
NameDescriptionTypeAdditional information
ID

string

None.

AddressID

string

None.

Name

string

None.

Actions

Collection of ScenarioAction

None.

Buttons

Collection of Button

None.

ButtonsSQL

string

None.

ButtonsToDelete

Collection of Button

None.

Response Formats

application/json, text/json

Sample:
[
  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
  }
]

text/html

Sample:
[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}]

application/xml, text/xml

Sample:
<ArrayOfScenario xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZPPModel.Model">
  <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>
</ArrayOfScenario>