GET api/v1/Floors?FacilityId={FacilityId}

Returns a list of floors (FloorsViewModel) 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 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

application/json, text/json

Sample:

[
  {
    "FloorId": "bbca37bb-ab6e-4b1c-a2af-e22bb300b3f3",
    "Name": "sample string 2",
    "PhysicalSequence": 3,
    "Deleted": true
  },
  {
    "FloorId": "bbca37bb-ab6e-4b1c-a2af-e22bb300b3f3",
    "Name": "sample string 2",
    "PhysicalSequence": 3,
    "Deleted": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFloorsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <FloorsViewModel>
    <Deleted>true</Deleted>
    <FloorId>bbca37bb-ab6e-4b1c-a2af-e22bb300b3f3</FloorId>
    <Name>sample string 2</Name>
    <PhysicalSequence>3</PhysicalSequence>
  </FloorsViewModel>
  <FloorsViewModel>
    <Deleted>true</Deleted>
    <FloorId>bbca37bb-ab6e-4b1c-a2af-e22bb300b3f3</FloorId>
    <Name>sample string 2</Name>
    <PhysicalSequence>3</PhysicalSequence>
  </FloorsViewModel>
</ArrayOfFloorsViewModel>