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

Name	Description	Type	Additional information
id		string	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	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": "34e7491a-8346-41ea-a643-ebef2e47c207",
  "FloorId": "1dbdf3f5-4dce-4fc9-86fe-8436eab4c48c",
  "ScheduleId": 3,
  "AccessRightsGrantedStart": "2024-04-18T11:47:42.6275513+00:00",
  "AccessRightsGrantedEnd": "2024-04-18T11:47:42.6275513+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>2024-04-18T11:47:42.6275513+00:00</AccessRightsGrantedEnd>
  <AccessRightsGrantedStart>2024-04-18T11:47:42.6275513+00:00</AccessRightsGrantedStart>
  <FloorId>1dbdf3f5-4dce-4fc9-86fe-8436eab4c48c</FloorId>
  <ScheduleId>3</ScheduleId>
  <UserId>34e7491a-8346-41ea-a643-ebef2e47c207</UserId>
</AddFloorAccessViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

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

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>