Create FloorPlanLayoutOpening

POST

api

sys

floorplanlayoutopenings

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplanlayoutopenings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FloorPlanLayoutEdgeId": 123,
  "OpeningType": "<string>",
  "FloorOffset": 123,
  "Start": 123,
  "Height": 123,
  "Length": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings"

payload = {
    "FloorPlanLayoutEdgeId": 123,
    "OpeningType": "<string>",
    "FloorOffset": 123,
    "Start": 123,
    "Height": 123,
    "Length": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    FloorPlanLayoutEdgeId: 123,
    OpeningType: '<string>',
    FloorOffset: 123,
    Start: 123,
    Height: 123,
    Length: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/floorplanlayoutopenings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Request Body

Required Fields

integer

required

ID of the floor plan layout edge linked to this record.

string

required

The opening type value for this floor plan layout opening.

integer

required

The floor offset value for this floor plan layout opening.

integer

required

The start value for this floor plan layout opening.

integer

required

The height value for this floor plan layout opening.

integer

required

The length value for this floor plan layout opening.

Optional Fields

string

The hinge value for this floor plan layout opening.

string

The door type value for this floor plan layout opening.

integer

The door arc angle value for this floor plan layout opening.

boolean

Whether door is locked is enabled.

integer

The window pane count value for this floor plan layout opening.

string

The direction value for this floor plan layout opening.

Code Examples

curl -X POST \
  "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
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      FloorPlanLayoutEdgeId: 0,
      OpeningType: '',
      FloorOffset: 0,
      Start: 0,
      Height: 0,
      Length: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/floorplanlayoutopenings',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'FloorPlanLayoutEdgeId': 0,
        'OpeningType': '',
        'FloorOffset': 0,
        'Start': 0,
        'Height': 0,
        'Length': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the floorplanlayoutopening was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "FloorPlanLayoutOpening was successfully created.",
  "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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update FloorPlanLayoutOpeningUpdate an existing FloorPlanLayoutOpening record.

Create FloorPlanLayoutOpening

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplanlayoutopenings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FloorPlanLayoutEdgeId": 123,
  "OpeningType": "<string>",
  "FloorOffset": 123,
  "Start": 123,
  "Height": 123,
  "Length": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/floorplanlayoutopenings"

payload = {
    "FloorPlanLayoutEdgeId": 123,
    "OpeningType": "<string>",
    "FloorOffset": 123,
    "Start": 123,
    "Height": 123,
    "Length": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    FloorPlanLayoutEdgeId: 123,
    OpeningType: '<string>',
    FloorOffset: 123,
    Start: 123,
    Height: 123,
    Length: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/floorplanlayoutopenings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create FloorPlanLayoutOpening

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400