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

Adds Floor Stop Access to an existing User. Returns Success/Error code plus primary key of UserFloorStop entry made.

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	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.

Request Formats

application/json, text/json

Sample:

{
  "UserId": "d799ae2e-a6e1-49c0-bcf1-00de135c09f0",
  "FloorStopId": 2,
  "ScheduleId": 3,
  "AccessRightsGrantedStart": "2024-04-19T14:55:17.2784752+00:00",
  "AccessRightsGrantedEnd": "2024-04-19T14:55:17.2784752+00:00"
}

application/xml, text/xml

Sample:

<AddFloorStopAccessViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <AccessRightsGrantedEnd>2024-04-19T14:55:17.2784752+00:00</AccessRightsGrantedEnd>
  <AccessRightsGrantedStart>2024-04-19T14:55:17.2784752+00:00</AccessRightsGrantedStart>
  <FloorStopId>2</FloorStopId>
  <ScheduleId>3</ScheduleId>
  <UserId>d799ae2e-a6e1-49c0-bcf1-00de135c09f0</UserId>
</AddFloorStopAccessViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultWithInt

Name	Description	Type	Additional information
Value	Represents the PK value that was created as a result of an add	integer	None.
ResultCode	Represents the result code	integer	None.
Description	Represents a description of the result code	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Value": 1,
  "ResultCode": 2,
  "Description": "sample string 3"
}

application/xml, text/xml

Sample:

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