POST api/v1/Users/{id}/FloorAccesses

Adds all Floor Stops pertaining to a given floor to an existing User. Returns Success/Error code.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

None.

Body Parameters

AddFloorAccessViewModel
NameDescriptionTypeAdditional 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

globally unique identifier

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.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "58fc1859-2646-4893-8764-5a250f05ffef",
  "FloorId": "bd22ee80-1aff-4a53-b3d4-7e6ccb52cbad",
  "ScheduleId": 3,
  "AccessRightsGrantedStart": "2026-03-01T06:41:27.5450878+00:00",
  "AccessRightsGrantedEnd": "2026-03-01T06:41:27.5450878+00:00"
}

application/xml, text/xml

Sample:
<AddFloorAccessViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <AccessRightsGrantedEnd>2026-03-01T06:41:27.5450878+00:00</AccessRightsGrantedEnd>
  <AccessRightsGrantedStart>2026-03-01T06:41:27.5450878+00:00</AccessRightsGrantedStart>
  <FloorId>bd22ee80-1aff-4a53-b3d4-7e6ccb52cbad</FloorId>
  <ScheduleId>3</ScheduleId>
  <UserId>58fc1859-2646-4893-8764-5a250f05ffef</UserId>
</AddFloorAccessViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional information
ResultCode

Represents the result code

integer

None.

Description

Represents a description of the result code

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResultCode": 1,
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Description>sample string 2</Description>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResultCode>1</ResultCode>
</Result>