Skip to main content
 
 
 
BluINFO

AddOccupancyFloor

Overview 

Adds a single Floor to the Occupancy. Returns Success/Error code plus primary key of Occupancy Floor added.

Request Information


Method

POST - api/Occupancy/AddOccupancyFloor

URI Parameters

None.

Body Parameters

AddUpdateOccupancyFloorViewModel

Name Description Type Additional information
OccupantFloorId

Represents the PK of the Occupancy Floor combination. Should be Null when passed to an Add action.

globally unique identifier

None.

OccupantId

Required: Represents the PK of the Occupancy

globally unique identifier

None.

FloorId

Required: Represents the PK of the Floor

globally unique identifier

None.

Deleted

Required: Represents whether the Occupancy / Floor combination is deleted or not. Should be false for an Add action.

boolean

None.

FloorUseFlagsMask

Required: 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.

IsDefaultMailFloor

Required: Represents whether the Occupancy / Floor combination is used as the default Mail Floor (assuming FloorUseFlagsMask contains bitmask value of 2). Only one floor can be the "default", so setting this to true will "steal" the attribute if it was previously assigned to another Occupancy Floor combination for the same Occupancy.

boolean

None.

IsDefaultReceptionFloor

Required: Represents whether the Occupancy / Floor combination is used as the default Reception Floor (assuming FloorUseFlagsMask contains bitmask value of 1). Only one floor can be the "default", so setting this to true will "steal" the attribute if it was previously assigned to another Occupancy Floor combination for the same Occupancy.

boolean

None.

IsDefaultOccupantFloor

Required: 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. Only one floor can be the "default", so setting this to true will "steal" the attribute if it was previously assigned to another Occupancy Floor combination for the same Occupancy.

boolean

None.

JSON

{
  "OccupantFloorId": "f2b35a39-fc08-4602-b665-dfc110c9b9b9",
  "OccupantId": "e12d20a9-0999-4a6c-b7fb-7c4d1240057e",
  "FloorId": "2210c749-d564-4443-b318-94aa4dc0076a",
  "Deleted": true,
  "FloorUseFlagsMask": 4,
  "IsDefaultMailFloor": true,
  "IsDefaultReceptionFloor": true,
  "IsDefaultOccupantFloor": true
}

XML

<AddUpdateOccupancyFloorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <Deleted>true</Deleted>
  <FloorId>2210c749-d564-4443-b318-94aa4dc0076a</FloorId>
  <FloorUseFlagsMask>4</FloorUseFlagsMask>
  <IsDefaultMailFloor>true</IsDefaultMailFloor>
  <IsDefaultOccupantFloor>true</IsDefaultOccupantFloor>
  <IsDefaultReceptionFloor>true</IsDefaultReceptionFloor>
  <OccupantFloorId>f2b35a39-fc08-4602-b665-dfc110c9b9b9</OccupantFloorId>
  <OccupantId>e12d20a9-0999-4a6c-b7fb-7c4d1240057e</OccupantId>
</AddUpdateOccupancyFloorViewModel>

Response Information 


Resource Description

ResultWithGuid

Name Description Type Additional information
ResultCode

Represents the result code

integer

None.

Description

Represents a description of the result code

string

None.

Value

Represents the PK value that was created as a result of an add

globally unique identifier

None.

Response Formats 

JSON

{
  "ResultCode": 1,
  "Description": "sample string 2",
  "Value": "bbb8650d-b444-45e4-98dd-b0e676ef998d"
}

XML

<ResultWithGuid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
  <Description>sample string 2</Description>
  <ResultCode>1</ResultCode>
  <Value>bbb8650d-b444-45e4-98dd-b0e676ef998d</Value>
</ResultWithGuid>
  • Was this article helpful?