Skip to main content
PUT
/
api
/
sys
/
floorplanlayoutopenings
Update FloorPlanLayoutOpening
curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/floorplanlayoutopenings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "FloorPlanLayoutEdgeId": 123,
  "OpeningType": "<string>",
  "FloorOffset": 123,
  "Start": 123,
  "Height": 123,
  "Length": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing FloorPlanLayoutOpening record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the FloorPlanLayoutOpening-Edit role.

Request Body

Required Fields

Id
integer
required
The Id of the FloorPlanLayoutOpening record to update.
FloorPlanLayoutEdgeId
integer
required
ID of the floor plan layout edge linked to this record.
OpeningType
string
required
The opening type value for this floor plan layout opening.
FloorOffset
integer
required
The floor offset value for this floor plan layout opening.
Start
integer
required
The start value for this floor plan layout opening.
Height
integer
required
The height value for this floor plan layout opening.
Length
integer
required
The length value for this floor plan layout opening.

Optional Fields

Hinge
string
The hinge value for this floor plan layout opening.
DoorType
string
The door type value for this floor plan layout opening.
DoorArcAngle
integer
The door arc angle value for this floor plan layout opening.
DoorIsLocked
boolean
Whether door is locked is enabled.
WindowPaneCount
integer
The window pane count value for this floor plan layout opening.
Direction
string
The direction value for this floor plan layout opening.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "FloorPlanLayoutEdgeId": 0,
    "OpeningType": "",
    "FloorOffset": 0,
    "Start": 0,
    "Height": 0,
    "Length": 0,
    "Id": 87654321
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the update.
Value
object
Contains the Id of the updated record.
WasSuccessful
boolean
true if the floorplanlayoutopening was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "FloorPlanLayoutOpening was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "OpeningType: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "OpeningType"
    }
  ],
  "WasSuccessful": false
}