GetFloorsByFacilityId
Overview
Returns a list of floors (FloorsViewModel) for a given Facility that the API token has rights to view.
Request Information
Method
GET - api/Floor/GetFloorsByFacilityId/{FacilityId}
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| FacilityId | globally unique identifier | Required |
Body Parameters
None.
Response Information
Resource Description
Collection of FloorsViewModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| FloorId | Represents the PK of the floor | globally unique identifier | None. |
| Name | Represents the name of the floor | string | None. |
| PhysicalSequence | Represents the physical sequence of the floor (negative numbers are below ground, positive are above) | integer | None. |
| Deleted | Represents the deleted status of the floor | boolean | None. |
Response Formats
JSON
\\\\[ { "FloorId": "a8ca8d88-c704-4cd0-9d4c-c102eba7e3dc", "Name": "sample string 2", "PhysicalSequence": 3, "Deleted": true }, { "FloorId": "a8ca8d88-c704-4cd0-9d4c-c102eba7e3dc", "Name": "sample string 2", "PhysicalSequence": 3, "Deleted": true } ]
XML
<ArrayOfFloorsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<FloorsViewModel>
<Deleted>true</Deleted>
<FloorId>a8ca8d88-c704-4cd0-9d4c-c102eba7e3dc</FloorId>
`<Name>`sample string 2</Name>
<PhysicalSequence>3</PhysicalSequence>
</FloorsViewModel>
<FloorsViewModel>
<Deleted>true</Deleted>
<FloorId>a8ca8d88-c704-4cd0-9d4c-c102eba7e3dc</FloorId>
`<Name>`sample string 2</Name>
<PhysicalSequence>3</PhysicalSequence>
</FloorsViewModel>
</ArrayOfFloorsViewModel>