GET api/v1/FloorStops?ElevatorBankId={ElevatorBankId}
Returns a list of floor stops for a given Elevator Bank that the API token has rights to view.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ElevatorBankId | 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": "fd68d4d3-ac63-4cbe-a056-c234b9bf8fbd", "FacilityName": "sample string 2", "FloorId": "d2c1e194-4674-4b2f-9c09-57ef3aed0b5b", "FloorName": "sample string 4", "FloorStopId": 5, "FloorStopName": "sample string 6", "ElevatorBankId": "357cba53-86cf-415d-9e5b-3575c33bd53f", "ElevatorBankName": "sample string 7", "ElevatorCarId": "3a6d7b4d-a5b8-4af4-a3eb-a752ee301d65", "ElevatorCarName": "sample string 9", "ElevatorDoorId": "acc35c86-a706-4edc-ab4a-0645002898a7", "ElevatorDoorName": "sample string 11", "Deleted": true }, { "FacilityId": "fd68d4d3-ac63-4cbe-a056-c234b9bf8fbd", "FacilityName": "sample string 2", "FloorId": "d2c1e194-4674-4b2f-9c09-57ef3aed0b5b", "FloorName": "sample string 4", "FloorStopId": 5, "FloorStopName": "sample string 6", "ElevatorBankId": "357cba53-86cf-415d-9e5b-3575c33bd53f", "ElevatorBankName": "sample string 7", "ElevatorCarId": "3a6d7b4d-a5b8-4af4-a3eb-a752ee301d65", "ElevatorCarName": "sample string 9", "ElevatorDoorId": "acc35c86-a706-4edc-ab4a-0645002898a7", "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>357cba53-86cf-415d-9e5b-3575c33bd53f</ElevatorBankId> <ElevatorBankName>sample string 7</ElevatorBankName> <ElevatorCarId>3a6d7b4d-a5b8-4af4-a3eb-a752ee301d65</ElevatorCarId> <ElevatorCarName>sample string 9</ElevatorCarName> <ElevatorDoorId>acc35c86-a706-4edc-ab4a-0645002898a7</ElevatorDoorId> <ElevatorDoorName>sample string 11</ElevatorDoorName> <FacilityId>fd68d4d3-ac63-4cbe-a056-c234b9bf8fbd</FacilityId> <FacilityName>sample string 2</FacilityName> <FloorId>d2c1e194-4674-4b2f-9c09-57ef3aed0b5b</FloorId> <FloorName>sample string 4</FloorName> <FloorStopId>5</FloorStopId> <FloorStopName>sample string 6</FloorStopName> </FloorStopViewModel> <FloorStopViewModel> <Deleted>true</Deleted> <ElevatorBankId>357cba53-86cf-415d-9e5b-3575c33bd53f</ElevatorBankId> <ElevatorBankName>sample string 7</ElevatorBankName> <ElevatorCarId>3a6d7b4d-a5b8-4af4-a3eb-a752ee301d65</ElevatorCarId> <ElevatorCarName>sample string 9</ElevatorCarName> <ElevatorDoorId>acc35c86-a706-4edc-ab4a-0645002898a7</ElevatorDoorId> <ElevatorDoorName>sample string 11</ElevatorDoorName> <FacilityId>fd68d4d3-ac63-4cbe-a056-c234b9bf8fbd</FacilityId> <FacilityName>sample string 2</FacilityName> <FloorId>d2c1e194-4674-4b2f-9c09-57ef3aed0b5b</FloorId> <FloorName>sample string 4</FloorName> <FloorStopId>5</FloorStopId> <FloorStopName>sample string 6</FloorStopName> </FloorStopViewModel> </ArrayOfFloorStopViewModel>