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 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": "364b74ec-5b3c-486e-b089-8465d8efaeae", "FacilityName": "sample string 2", "FloorId": "88e5f9ab-53b1-4230-b9f3-fd57bf239b01", "FloorName": "sample string 4", "FloorStopId": 5, "FloorStopName": "sample string 6", "ElevatorBankId": "7b1e9af2-e6d5-4fa2-9942-f400b7e6111f", "ElevatorBankName": "sample string 7", "ElevatorCarId": "319cf0e0-1d8c-49d3-8b8c-b738a737c636", "ElevatorCarName": "sample string 9", "ElevatorDoorId": "09c95c61-a8be-43e3-8e10-c749c32b4650", "ElevatorDoorName": "sample string 11", "Deleted": true }, { "FacilityId": "364b74ec-5b3c-486e-b089-8465d8efaeae", "FacilityName": "sample string 2", "FloorId": "88e5f9ab-53b1-4230-b9f3-fd57bf239b01", "FloorName": "sample string 4", "FloorStopId": 5, "FloorStopName": "sample string 6", "ElevatorBankId": "7b1e9af2-e6d5-4fa2-9942-f400b7e6111f", "ElevatorBankName": "sample string 7", "ElevatorCarId": "319cf0e0-1d8c-49d3-8b8c-b738a737c636", "ElevatorCarName": "sample string 9", "ElevatorDoorId": "09c95c61-a8be-43e3-8e10-c749c32b4650", "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>7b1e9af2-e6d5-4fa2-9942-f400b7e6111f</ElevatorBankId> <ElevatorBankName>sample string 7</ElevatorBankName> <ElevatorCarId>319cf0e0-1d8c-49d3-8b8c-b738a737c636</ElevatorCarId> <ElevatorCarName>sample string 9</ElevatorCarName> <ElevatorDoorId>09c95c61-a8be-43e3-8e10-c749c32b4650</ElevatorDoorId> <ElevatorDoorName>sample string 11</ElevatorDoorName> <FacilityId>364b74ec-5b3c-486e-b089-8465d8efaeae</FacilityId> <FacilityName>sample string 2</FacilityName> <FloorId>88e5f9ab-53b1-4230-b9f3-fd57bf239b01</FloorId> <FloorName>sample string 4</FloorName> <FloorStopId>5</FloorStopId> <FloorStopName>sample string 6</FloorStopName> </FloorStopViewModel> <FloorStopViewModel> <Deleted>true</Deleted> <ElevatorBankId>7b1e9af2-e6d5-4fa2-9942-f400b7e6111f</ElevatorBankId> <ElevatorBankName>sample string 7</ElevatorBankName> <ElevatorCarId>319cf0e0-1d8c-49d3-8b8c-b738a737c636</ElevatorCarId> <ElevatorCarName>sample string 9</ElevatorCarName> <ElevatorDoorId>09c95c61-a8be-43e3-8e10-c749c32b4650</ElevatorDoorId> <ElevatorDoorName>sample string 11</ElevatorDoorName> <FacilityId>364b74ec-5b3c-486e-b089-8465d8efaeae</FacilityId> <FacilityName>sample string 2</FacilityName> <FloorId>88e5f9ab-53b1-4230-b9f3-fd57bf239b01</FloorId> <FloorName>sample string 4</FloorName> <FloorStopId>5</FloorStopId> <FloorStopName>sample string 6</FloorStopName> </FloorStopViewModel> </ArrayOfFloorStopViewModel>