Skip to main content
GET
/
api
/
sys
/
floorplanlayoutopenings
/
{id}
Get one FloorPlanLayoutOpening
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplanlayoutopenings/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "FloorPlanLayoutEdgeId": 123,
  "FloorPlanLayoutEdgeName": "<string>",
  "OpeningType": "<string>",
  "FloorOffset": 123,
  "Start": 123,
  "Height": 123,
  "Length": 123,
  "Hinge": "<string>",
  "DoorType": "<string>",
  "DoorArcAngle": 123,
  "DoorIsLocked": true,
  "WindowPaneCount": 123,
  "Direction": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A FloorPlanLayoutOpening represents a door, window, or other opening in a floor plan layout wall or boundary edge.

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-Read role.

Path Parameters

id
integer
required
The Id of the FloorPlanLayoutOpening record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

FloorPlanLayoutEdgeId
integer
ID of the floor plan layout edge linked to this record.
FloorPlanLayoutEdgeName
string
Display name of the linked floor plan layout edge (read-only).
OpeningType
string
The opening type value for this floor plan layout opening.
FloorOffset
integer
The floor offset value for this floor plan layout opening.
Start
integer
The start value for this floor plan layout opening.
Height
integer
The height value for this floor plan layout opening.
Length
integer
The length value for this floor plan layout opening.
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.
Id
integer
Unique record identifier.
UniqueId
string
UUID of the record.
CreatedOn
string
Date and time the record was created (ISO 8601).
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
UpdatedBy
string
Email of the user who last updated this record.
IsNew
boolean
Whether the record was recently created.
SystemId
string
External system identifier.
Example Response
{
  "FloorPlanLayoutEdgeId": 0,
  "FloorPlanLayoutEdgeName": null,
  "OpeningType": "",
  "FloorOffset": 0,
  "Start": 0,
  "Height": 0,
  "Length": 0,
  "Hinge": null,
  "DoorType": null,
  "DoorArcAngle": null,
  "DoorIsLocked": false,
  "WindowPaneCount": null,
  "Direction": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "FloorPlanLayoutOpening Example",
  "LocalizationDetails": null,
  "CustomFields": null
}