Skip to main content

UpdateOccupancyFloor

Overview​

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

Request Information​

Method​

POST - api/Occupancy/UpdateOccupancyFloor

URI Parameters​

None.

Body Parameters

AddUpdateOccupancyFloorViewModel

NameDescriptionTypeAdditional information
OccupantFloorIdRepresents the PK of the Occupancy Floor combination. Should be Null when passed to an Add action.globally unique identifierNone.
OccupantIdRequired: Represents the PK of the Occupancyglobally unique identifierNone.
FloorIdRequired: Represents the PK of the Floorglobally unique identifierNone.
DeletedRequired: Represents whether the Occupancy / Floor combination is deleted or not. Should be false for an Add action.booleanNone.
FloorUseFlagsMaskRequired: 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/IndustrialintegerNone.
IsDefaultMailFloorRequired: 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.booleanNone.
IsDefaultReceptionFloorRequired: 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.booleanNone.
IsDefaultOccupantFloorRequired: 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.booleanNone.

JSON​

{
 "OccupantFloorId": "0ec2e30e-512a-4351-9b78-dbdf40bbb8f0",
 "OccupantId": "2712f132-4c8c-4b3f-a9de-a9a357849062",
 "FloorId": "91a01f91-8cb4-4ebc-bfeb-f1a21f9e9196",
 "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>91a01f91-8cb4-4ebc-bfeb-f1a21f9e9196</FloorId>
 <FloorUseFlagsMask>4</FloorUseFlagsMask>
 <IsDefaultMailFloor>true</IsDefaultMailFloor>
 <IsDefaultOccupantFloor>true</IsDefaultOccupantFloor>
 <IsDefaultReceptionFloor>true</IsDefaultReceptionFloor>
 <OccupantFloorId>0ec2e30e-512a-4351-9b78-dbdf40bbb8f0</OccupantFloorId>
 <OccupantId>2712f132-4c8c-4b3f-a9de-a9a357849062</OccupantId>
</AddUpdateOccupancyFloorViewModel>

Response Information​

Resource Description​

ResultWithGuid

NameDescriptionTypeAdditional information
ResultCodeRepresents the result codeintegerNone.
DescriptionRepresents a description of the result codestringNone.
ValueRepresents the PK value that was created as a result of an addglobally unique identifierNone.

Response Formats​

JSON​

{
 "ResultCode": 1,
 "Description": "sample string 2",
 "Value": "42837f67-37ec-4dc8-bbda-e730b60b9417"
}

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>`42837f67-37ec-4dc8-bbda-e730b60b9417</Value>
</ResultWithGuid>