AddFloorStopAccess
Overview
Adds Floor Stop Access to an existing User. Returns Success/Error code plus primary key of UserFloorStop entry made.
Request Information
Method
POST - api/Person/AddFloorStopAccess
URI Parameters
None.
Body Parameters
AddFloorStopAccessViewModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | Required: Represents the PK of an existing User | globally unique identifier | None. |
| FloorStopId | Required: Represents the PK of an existing Floor Stop | integer | None. |
| ScheduleId | Required: Represents the PK of an existing Schedule that will restrict access to this Floor Stop for this User | integer | None. |
| AccessRightsGrantedStart | Optional: The DateTime when the User's Access Rights to this Floor Stop will become active. If null, access will be granted immediately. | date | None. |
| AccessRightsGrantedEnd | Optional: The DateTime when the User's Access Rights to this Floor Stop will become inactive. If null, access will be granted indefinitely. | date | None. |
JSON
{
"UserId": "f0bc29dc-0ead-42ba-bd3f-2f0f9d7d331d",
"FloorStopId": 2,
"ScheduleId": 3,
"AccessRightsGrantedStart": "2016-12-14T00:08:44.4626012-05:00",
"AccessRightsGrantedEnd": "2016-12-14T00:08:44.4626012-05:00"
}
XML
<AddFloorStopAccessViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<AccessRightsGrantedEnd>2016-12-14T00:08:44.4626012-05:00</AccessRightsGrantedEnd>
<AccessRightsGrantedStart>2016-12-14T00:08:44.4626012-05:00</AccessRightsGrantedStart>
<FloorStopId>2</FloorStopId>
<ScheduleId>3</ScheduleId>
<UserId>f0bc29dc-0ead-42ba-bd3f-2f0f9d7d331d</UserId>
</AddFloorStopAccessViewModel>
Response Information
Resource Description
ResultWithInt
| 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 | integer | None. |
Response Formats
JSON
{
"ResultCode": 1,
"Description": "sample string 2",
"Value": 3
}
XML
<ResultWithInt 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>`3</Value>
</ResultWithInt>