Skip to main content
BluINFO

GetFloorStopsByFloorId

Overview 

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

Request Information


Method

GET - api/FloorStop/GetFloorStopsByFloorId/{FloorId}

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

globally unique identifier

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

globally unique identifier

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

globally unique identifier

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

globally unique identifier

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

globally unique identifier

None.

Deleted

Represents the deleted status of the floor stop

boolean

None.

Response Formats 

JSON

[
  {
    "FacilityId": "56479cc9-1ee3-4b32-a34e-29978317a443",
    "FacilityName": "ecefe9c0-7e78-48aa-b223-93c9cbee1ed7",
    "FloorId": "03a69d25-400f-49ce-b875-8d0f12f0c978",
    "FloorName": "sample string 4",
    "FloorStopId": "2ce32810-2872-4b59-a61d-277862e0bcb8",
    "FloorStopName": "sample string 6",
    "ElevatorBankId": "598ad8b2-f6c3-4f24-9417-31edf649b835",
    "ElevatorBankName": "814379eb-e2bc-49d9-b3f9-30a05929dc03",
    "ElevatorCarId": "41566aee-7bc4-4424-aca0-0dd2bf4a8102",
    "ElevatorCarName": "27278691-afdf-4bdc-a54e-a514e8d52d5a",
    "ElevatorDoorId": "c5cd3980-90bc-4fd9-959e-3ea4aec22805",
    "ElevatorDoorName": "a26a3fcb-a992-49f5-9d23-0ef60f448a19",
    "Deleted": true
  },
  {
    "FacilityId": "56479cc9-1ee3-4b32-a34e-29978317a443",
    "FacilityName": "ecefe9c0-7e78-48aa-b223-93c9cbee1ed7",
    "FloorId": "03a69d25-400f-49ce-b875-8d0f12f0c978",
    "FloorName": "sample string 4",
    "FloorStopId": "2ce32810-2872-4b59-a61d-277862e0bcb8",
    "FloorStopName": "sample string 6",
    "ElevatorBankId": "598ad8b2-f6c3-4f24-9417-31edf649b835",
    "ElevatorBankName": "814379eb-e2bc-49d9-b3f9-30a05929dc03",
    "ElevatorCarId": "41566aee-7bc4-4424-aca0-0dd2bf4a8102",
    "ElevatorCarName": "27278691-afdf-4bdc-a54e-a514e8d52d5a",
    "ElevatorDoorId": "c5cd3980-90bc-4fd9-959e-3ea4aec22805",
    "ElevatorDoorName": "a26a3fcb-a992-49f5-9d23-0ef60f448a19",
    "Deleted": true
  }
]

XML

<ArrayOfFloorStopViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <FloorStopViewModel>
    <Deleted>true</Deleted>
    <ElevatorBankId>598ad8b2-f6c3-4f24-9417-31edf649b835</ElevatorBankId>
    <ElevatorBankName>814379eb-e2bc-49d9-b3f9-30a05929dc03</ElevatorBankName>
    <ElevatorCarId>41566aee-7bc4-4424-aca0-0dd2bf4a8102</ElevatorCarId>
    <ElevatorCarName>27278691-afdf-4bdc-a54e-a514e8d52d5a</ElevatorCarName>
    <ElevatorDoorId>c5cd3980-90bc-4fd9-959e-3ea4aec22805</ElevatorDoorId>
    <ElevatorDoorName>a26a3fcb-a992-49f5-9d23-0ef60f448a19</ElevatorDoorName>
    <FacilityId>56479cc9-1ee3-4b32-a34e-29978317a443</FacilityId>
    <FacilityName>ecefe9c0-7e78-48aa-b223-93c9cbee1ed7</FacilityName>
    <FloorId>03a69d25-400f-49ce-b875-8d0f12f0c978</FloorId>
    <FloorName>sample string 4</FloorName>
    <FloorStopId>2ce32810-2872-4b59-a61d-277862e0bcb8</FloorStopId>
    <FloorStopName>sample string 6</FloorStopName>
  </FloorStopViewModel>
  <FloorStopViewModel>
    <Deleted>true</Deleted>
    <ElevatorBankId>598ad8b2-f6c3-4f24-9417-31edf649b835</ElevatorBankId>
    <ElevatorBankName>814379eb-e2bc-49d9-b3f9-30a05929dc03</ElevatorBankName>
    <ElevatorCarId>41566aee-7bc4-4424-aca0-0dd2bf4a8102</ElevatorCarId>
    <ElevatorCarName>27278691-afdf-4bdc-a54e-a514e8d52d5a</ElevatorCarName>
    <ElevatorDoorId>c5cd3980-90bc-4fd9-959e-3ea4aec22805</ElevatorDoorId>
    <ElevatorDoorName>a26a3fcb-a992-49f5-9d23-0ef60f448a19</ElevatorDoorName>
    <FacilityId>56479cc9-1ee3-4b32-a34e-29978317a443</FacilityId>
    <FacilityName>ecefe9c0-7e78-48aa-b223-93c9cbee1ed7</FacilityName>
    <FloorId>03a69d25-400f-49ce-b875-8d0f12f0c978</FloorId>
    <FloorName>sample string 4</FloorName>
    <FloorStopId>2ce32810-2872-4b59-a61d-277862e0bcb8</FloorStopId>
    <FloorStopName>sample string 6</FloorStopName>
  </FloorStopViewModel>
</ArrayOfFloorStopViewModel>
  • Was this article helpful?