GET api/v1/FloorStops?FloorId={FloorId}

Returns a list of floor stops for a given Floor that the API token has rights to view.

Request Information

URI Parameters

Name	Description	Type	Additional information
FloorId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of FloorStopViewModel

Name	Description	Type	Additional information
FacilityId	Represents the PK of the facility for the floor that the floor stop services	globally unique identifier	None.
FacilityName	Represents the name of the facility for the floor that the floor stop services	string	None.
FloorId	Represents the PK of the floor that the floor stop services	globally unique identifier	None.
FloorName	Represents the name of the floor that the floor stop services	string	None.
FloorStopId	Represents the PK of the floor stop	integer	None.
FloorStopName	Represents the name of the floor stop	string	None.
ElevatorBankId	Represents the PK of the elevator bank serving the floor stop	globally unique identifier	None.
ElevatorBankName	Represents the name of the elevator bank serving the floor stop	string	None.
ElevatorCarId	Represents the PK of the elevator serving the floor stop	globally unique identifier	None.
ElevatorCarName	Represents the name of the elevator serving the floor stop	string	None.
ElevatorDoorId	Represents the PK of the elevator door serving the floor stop	globally unique identifier	None.
ElevatorDoorName	Represents the name of the elevator door serving the floor stop	string	None.
Deleted	Represents the deleted status of the floor stop	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "FacilityId": "52e70fcc-5818-45b6-a459-204e11baee33",
    "FacilityName": "sample string 2",
    "FloorId": "0b25571c-243b-4e0b-a58b-2a6872450258",
    "FloorName": "sample string 4",
    "FloorStopId": 5,
    "FloorStopName": "sample string 6",
    "ElevatorBankId": "ac37d8c5-ff75-429e-9bab-54c9dc8a0620",
    "ElevatorBankName": "sample string 7",
    "ElevatorCarId": "dfb39187-08d7-43d1-8bb3-884aef6797b6",
    "ElevatorCarName": "sample string 9",
    "ElevatorDoorId": "226c3abb-4723-41c1-b150-477411d6b09d",
    "ElevatorDoorName": "sample string 11",
    "Deleted": true
  },
  {
    "FacilityId": "52e70fcc-5818-45b6-a459-204e11baee33",
    "FacilityName": "sample string 2",
    "FloorId": "0b25571c-243b-4e0b-a58b-2a6872450258",
    "FloorName": "sample string 4",
    "FloorStopId": 5,
    "FloorStopName": "sample string 6",
    "ElevatorBankId": "ac37d8c5-ff75-429e-9bab-54c9dc8a0620",
    "ElevatorBankName": "sample string 7",
    "ElevatorCarId": "dfb39187-08d7-43d1-8bb3-884aef6797b6",
    "ElevatorCarName": "sample string 9",
    "ElevatorDoorId": "226c3abb-4723-41c1-b150-477411d6b09d",
    "ElevatorDoorName": "sample string 11",
    "Deleted": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFloorStopViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <FloorStopViewModel>
    <Deleted>true</Deleted>
    <ElevatorBankId>ac37d8c5-ff75-429e-9bab-54c9dc8a0620</ElevatorBankId>
    <ElevatorBankName>sample string 7</ElevatorBankName>
    <ElevatorCarId>dfb39187-08d7-43d1-8bb3-884aef6797b6</ElevatorCarId>
    <ElevatorCarName>sample string 9</ElevatorCarName>
    <ElevatorDoorId>226c3abb-4723-41c1-b150-477411d6b09d</ElevatorDoorId>
    <ElevatorDoorName>sample string 11</ElevatorDoorName>
    <FacilityId>52e70fcc-5818-45b6-a459-204e11baee33</FacilityId>
    <FacilityName>sample string 2</FacilityName>
    <FloorId>0b25571c-243b-4e0b-a58b-2a6872450258</FloorId>
    <FloorName>sample string 4</FloorName>
    <FloorStopId>5</FloorStopId>
    <FloorStopName>sample string 6</FloorStopName>
  </FloorStopViewModel>
  <FloorStopViewModel>
    <Deleted>true</Deleted>
    <ElevatorBankId>ac37d8c5-ff75-429e-9bab-54c9dc8a0620</ElevatorBankId>
    <ElevatorBankName>sample string 7</ElevatorBankName>
    <ElevatorCarId>dfb39187-08d7-43d1-8bb3-884aef6797b6</ElevatorCarId>
    <ElevatorCarName>sample string 9</ElevatorCarName>
    <ElevatorDoorId>226c3abb-4723-41c1-b150-477411d6b09d</ElevatorDoorId>
    <ElevatorDoorName>sample string 11</ElevatorDoorName>
    <FacilityId>52e70fcc-5818-45b6-a459-204e11baee33</FacilityId>
    <FacilityName>sample string 2</FacilityName>
    <FloorId>0b25571c-243b-4e0b-a58b-2a6872450258</FloorId>
    <FloorName>sample string 4</FloorName>
    <FloorStopId>5</FloorStopId>
    <FloorStopName>sample string 6</FloorStopName>
  </FloorStopViewModel>
</ArrayOfFloorStopViewModel>