Create FloorPlanLayout

POST

api

sys

floorplanlayouts

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplanlayouts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Size": 123,
  "BackgroundImageScale": 123,
  "TracingImageScale": 123,
  "FloorLevel": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Size": 123,
    "BackgroundImageScale": 123,
    "TracingImageScale": 123,
    "FloorLevel": 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({
    BusinessId: 123,
    Name: '<string>',
    Size: 123,
    BackgroundImageScale: 123,
    TracingImageScale: 123,
    FloorLevel: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/floorplanlayouts', 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 FloorPlanLayout represents the overall layout configuration of a floor plan, including its dimensions, background image, and visual settings. Each floor plan can have one or more layouts to represent different configurations of the same space.

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 FloorPlanLayout-Create role.

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

The name value for this floor plan layout.

number

required

The size value for this floor plan layout.

integer

required

The background image scale value for this floor plan layout.

integer

required

The tracing image scale value for this floor plan layout.

integer

required

The floor level value for this floor plan layout.

Optional Fields

string

URL of a new file to upload as the background image.

boolean

Set to true to remove the current background image file.

string

URL of a new file to upload as the tracing image.

boolean

Set to true to remove the current tracing image file.

string

URL of a new file to upload as the preview image.

boolean

Set to true to remove the current preview image file.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/floorplanlayouts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Size": 0,
    "BackgroundImageScale": 0,
    "TracingImageScale": 0,
    "FloorLevel": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplanlayouts',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Size: 0,
      BackgroundImageScale: 0,
      TracingImageScale: 0,
      FloorLevel: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/floorplanlayouts',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Size': 0,
        'BackgroundImageScale': 0,
        'TracingImageScale': 0,
        'FloorLevel': 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 floorplanlayout was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "FloorPlanLayout 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": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update FloorPlanLayoutUpdate an existing FloorPlanLayout record.

Create FloorPlanLayout

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplanlayouts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Size": 123,
  "BackgroundImageScale": 123,
  "TracingImageScale": 123,
  "FloorLevel": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Size": 123,
    "BackgroundImageScale": 123,
    "TracingImageScale": 123,
    "FloorLevel": 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({
    BusinessId: 123,
    Name: '<string>',
    Size: 123,
    BackgroundImageScale: 123,
    TracingImageScale: 123,
    FloorLevel: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/floorplanlayouts', 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

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