GET api/v1/FloorStops?FacilityId={FacilityId}
Returns a list of floor stops for a given Facility that the API token has rights to view.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
FacilityId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of FloorStopViewModelName | 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
[ { "FacilityId": "641f2f14-64a6-4714-9a8b-f72236911b73", "FacilityName": "sample string 2", "FloorId": "3212b209-cac7-4f20-8c70-a35a4ab37698", "FloorName": "sample string 4", "FloorStopId": 5, "FloorStopName": "sample string 6", "ElevatorBankId": "769bd9df-72d4-4387-af35-b7d3b6c1b4e4", "ElevatorBankName": "sample string 7", "ElevatorCarId": "b8f784f2-711e-475f-8c36-7525367b9e20", "ElevatorCarName": "sample string 9", "ElevatorDoorId": "4a839ef2-5dc2-457e-be1e-e09e389c891e", "ElevatorDoorName": "sample string 11", "Deleted": true }, { "FacilityId": "641f2f14-64a6-4714-9a8b-f72236911b73", "FacilityName": "sample string 2", "FloorId": "3212b209-cac7-4f20-8c70-a35a4ab37698", "FloorName": "sample string 4", "FloorStopId": 5, "FloorStopName": "sample string 6", "ElevatorBankId": "769bd9df-72d4-4387-af35-b7d3b6c1b4e4", "ElevatorBankName": "sample string 7", "ElevatorCarId": "b8f784f2-711e-475f-8c36-7525367b9e20", "ElevatorCarName": "sample string 9", "ElevatorDoorId": "4a839ef2-5dc2-457e-be1e-e09e389c891e", "ElevatorDoorName": "sample string 11", "Deleted": true } ]
application/xml, text/xml
<ArrayOfFloorStopViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <FloorStopViewModel> <Deleted>true</Deleted> <ElevatorBankId>769bd9df-72d4-4387-af35-b7d3b6c1b4e4</ElevatorBankId> <ElevatorBankName>sample string 7</ElevatorBankName> <ElevatorCarId>b8f784f2-711e-475f-8c36-7525367b9e20</ElevatorCarId> <ElevatorCarName>sample string 9</ElevatorCarName> <ElevatorDoorId>4a839ef2-5dc2-457e-be1e-e09e389c891e</ElevatorDoorId> <ElevatorDoorName>sample string 11</ElevatorDoorName> <FacilityId>641f2f14-64a6-4714-9a8b-f72236911b73</FacilityId> <FacilityName>sample string 2</FacilityName> <FloorId>3212b209-cac7-4f20-8c70-a35a4ab37698</FloorId> <FloorName>sample string 4</FloorName> <FloorStopId>5</FloorStopId> <FloorStopName>sample string 6</FloorStopName> </FloorStopViewModel> <FloorStopViewModel> <Deleted>true</Deleted> <ElevatorBankId>769bd9df-72d4-4387-af35-b7d3b6c1b4e4</ElevatorBankId> <ElevatorBankName>sample string 7</ElevatorBankName> <ElevatorCarId>b8f784f2-711e-475f-8c36-7525367b9e20</ElevatorCarId> <ElevatorCarName>sample string 9</ElevatorCarName> <ElevatorDoorId>4a839ef2-5dc2-457e-be1e-e09e389c891e</ElevatorDoorId> <ElevatorDoorName>sample string 11</ElevatorDoorName> <FacilityId>641f2f14-64a6-4714-9a8b-f72236911b73</FacilityId> <FacilityName>sample string 2</FacilityName> <FloorId>3212b209-cac7-4f20-8c70-a35a4ab37698</FloorId> <FloorName>sample string 4</FloorName> <FloorStopId>5</FloorStopId> <FloorStopName>sample string 6</FloorStopName> </FloorStopViewModel> </ArrayOfFloorStopViewModel>