Skip to main content
 
 
 
BluINFO

GetOccupancyFloors

Overview 

Gets a list of all Floors occupied by an Occupancy

Request Information


Method

GET - api/Occupancy/GetOccupancyFloors/{OccupancyId}

URI Parameters

None.

Name Description Type Additional information
OccupancyId

 

globally unique identifier

Required

Body Parameters

None.

Response Information 


Resource Description

Collection of OccupancyFloorViewModel

Name Description Type Additional information
OccupantFloorId

Represents the PK of the Occupancy Floor combination

globally unique identifier

None.

OccupantId

Represents the PK of the Occupancy

globally unique identifier

None.

OccupancyName

Represents the name of the Occupancy

string

None.

FloorId

Represents the PK of the Floor

globally unique identifier

None.

FloorName

Represents the name of the Floor

string

None.

Deleted

Represents whether the Occupancy / Floor combination is deleted or not.

boolean

None.

FloorUseFlagsMask

Represents a bitmask of how the floor is used by the Occupancy. 1 = Reception, 2 = Mail/Deliver, 4 = Office Space, 8 = Retail, 16 = Residential, 32 = Commercial/Industrial

integer

None.

FloorUses

Represents a concatenation of the descriptions for the bitmasks set by FloorUseFlagsMask. Example "Reception, Office Space"

integer

None.

IsDefaultMailFloor

Represents whether the Occupancy / Floor combination is used as the default Mail Floor (assuming FloorUseFlagsMask contains bitmask value of 2)

boolean

None.

IsDefaultReceptionFloor

Represents whether the Occupancy / Floor combination is used as the default Reception Floor (assuming FloorUseFlagsMask contains bitmask value of 1)

boolean

None.

IsDefaultOccupantFloor

Represents whether the Occupancy / Floor combination is used as the default Occupancy Floor (assuming FloorUseFlagsMask contains bitmask value of 4). This is used to determine default floors of new employees amongst other things.

boolean

None.

Response Formats 

JSON

[
  {
    "OccupantFloorId": "d30a4eaf-b268-44b6-9de5-9310d6298ecb",
    "OccupantId": "0e86e7a3-b9e9-46d2-b9de-8e1b427d6e33",
    "OccupancyName": "sample string 3",
    "FloorId": "8f8b298b-c71d-4e9b-8577-3825bbb24b89",
    "FloorName": "sample string 5",
    "Deleted": true,
    "FloorUseFlagsMask": 7,
    "FloorUses": 8,
    "IsDefaultMailFloor": true,
    "IsDefaultReceptionFloor": true,
    "IsDefaultOccupantFloor": true
  },
  {
    "OccupantFloorId": "d30a4eaf-b268-44b6-9de5-9310d6298ecb",
    "OccupantId": "0e86e7a3-b9e9-46d2-b9de-8e1b427d6e33",
    "OccupancyName": "sample string 3",
    "FloorId": "8f8b298b-c71d-4e9b-8577-3825bbb24b89",
    "FloorName": "sample string 5",
    "Deleted": true,
    "FloorUseFlagsMask": 7,
    "FloorUses": 8,
    "IsDefaultMailFloor": true,
    "IsDefaultReceptionFloor": true,
    "IsDefaultOccupantFloor": true
  }
]

XML

<ArrayOfOccupancyFloorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <OccupancyFloorViewModel>
    <Deleted>true</Deleted>
    <FloorId>8f8b298b-c71d-4e9b-8577-3825bbb24b89</FloorId>
    <FloorName>sample string 5</FloorName>
    <FloorUseFlagsMask>7</FloorUseFlagsMask>
    <FloorUses>8</FloorUses>
    <IsDefaultMailFloor>true</IsDefaultMailFloor>
    <IsDefaultOccupantFloor>true</IsDefaultOccupantFloor>
    <IsDefaultReceptionFloor>true</IsDefaultReceptionFloor>
    <OccupancyName>sample string 3</OccupancyName>
    <OccupantFloorId>d30a4eaf-b268-44b6-9de5-9310d6298ecb</OccupantFloorId>
    <OccupantId>0e86e7a3-b9e9-46d2-b9de-8e1b427d6e33</OccupantId>
  </OccupancyFloorViewModel>
  <OccupancyFloorViewModel>
    <Deleted>true</Deleted>
    <FloorId>8f8b298b-c71d-4e9b-8577-3825bbb24b89</FloorId>
    <FloorName>sample string 5</FloorName>
    <FloorUseFlagsMask>7</FloorUseFlagsMask>
    <FloorUses>8</FloorUses>
    <IsDefaultMailFloor>true</IsDefaultMailFloor>
    <IsDefaultOccupantFloor>true</IsDefaultOccupantFloor>
    <IsDefaultReceptionFloor>true</IsDefaultReceptionFloor>
    <OccupancyName>sample string 3</OccupancyName>
    <OccupantFloorId>d30a4eaf-b268-44b6-9de5-9310d6298ecb</OccupantFloorId>
    <OccupantId>0e86e7a3-b9e9-46d2-b9de-8e1b427d6e33</OccupantId>
  </OccupancyFloorViewModel>
</ArrayOfOccupancyFloorViewModel>
  • Was this article helpful?