RemoveFloorAccess
Overview
Removes all Floor Stops pertaining to a given floor from an existing User. Returns Success/Error code.
Request Information
Method
POST - api/Person/RemoveFloorAccess
URI Parameters
None.
Body Parameters
RemoveFloorAccessViewModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | Required: Represents the PK of an existing User | globally unique identifier | None. |
| FloorId | Required: Represents the PK of an existing Floor, all of whose Floor Stops across all elevators you wish to remove from the User | integer | None. |
JSON
{
"UserId": "86313c15-f325-4bb9-85d2-9d5e418076e3",
"FloorId": 2
}
XML
<RemoveFloorAccessViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<FloorId>2</FloorId>
<UserId>86313c15-f325-4bb9-85d2-9d5e418076e3</UserId>
</RemoveFloorAccessViewModel>
Response Information
Resource Description
Result
| Name | Description | Type | Additional information |
|---|---|---|---|
| ResultCode | Represents the result code | integer | None. |
| Description | Represents a description of the result code | string | None. |
Response Formats
JSON
{
"ResultCode": 1,
"Description": "sample string 2"
}
XML
<Result 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>
</Result>