AddFloorAccess
Overview
Request Information
Method
POST api/Person/AddFloorAccess
URI Parameters
None.
Body Parameters
AddFloorAccessViewModel
| 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 assign to the User |
integer |
None. |
| ScheduleId |
Required: Represents the PK of an existing Schedule that will restrict access to this Floor's Floor Stops for this User |
integer |
None. |
| AccessRightsGrantedStart |
Optional: The DateTime when the User's Access Rights to these Floor Stops will become active. If null, access will be granted immediately. |
date |
None. |
| AccessRightsGrantedEnd |
Optional: The DateTime when the User's Access Rights to these Floor Stops will become inactive. If null, access will be granted indefinitely. |
date |
None. |
JSON
1 | { |
2 | "UserId": "e8e4b2de-c030-4314-b254-f999eca61ae4", |
3 | "FloorId": 2, |
4 | "ScheduleId": 3, |
5 | "AccessRightsGrantedStart": "2016-12-14T00:08:46.434951-05:00", |
6 | "AccessRightsGrantedEnd": "2016-12-14T00:08:46.434951-05:00" |
7 | } |
XML
1 | <AddFloorAccessViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers"> |
2 | <AccessRightsGrantedEnd>2016-12-14T00:08:46.434951-05:00</AccessRightsGrantedEnd> |
3 | <AccessRightsGrantedStart>2016-12-14T00:08:46.434951-05:00</AccessRightsGrantedStart> |
4 | <FloorId>2</FloorId> |
5 | <ScheduleId>3</ScheduleId> |
6 | <UserId>e8e4b2de-c030-4314-b254-f999eca61ae4</UserId> |
7 | </AddFloorAccessViewModel> |
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
1 | { |
2 | "ResultCode": 1, |
3 | "Description": "sample string 2" |
4 | } |
XML
1 | <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers"> |
2 | <Description>sample string 2</Description> |
3 | <ResultCode>1</ResultCode> |
4 | </Result> |