Create FloorPlan

POST

api

sys

floorplans

Create FloorPlan

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

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "BackgroundScale": 123,
    "PositionX": 123,
    "PositionY": 123,
    "FloorLevel": 123,
    "Scale": 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>',
    BackgroundScale: 123,
    PositionX: 123,
    PositionY: 123,
    FloorLevel: 123,
    Scale: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/floorplans', 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 floor plan represents one floor at a location and groups the bookable or assignable floor plan units shown through an uploaded image, a Nexudus Floor Plan Editor layout, or an Archilogic 3D scene.

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

Request Body

Required Fields

integer

required

ID of the required location that owns this floor plan.

string

required

Required display name; changing it also updates the associated editor layout name and floor plan unit names containing the previous name.

integer

required

Integer percentage used to scale floor plan unit coordinates over the background image; 100 is full scale, values above 100 are capped at 100 when rendered, and non-positive values render at 33.

integer

required

Legacy horizontal floor plan offset; the current editor stores each unit’s horizontal canvas coordinate in FloorPlanDesk.PositionX instead.

integer

required

Legacy vertical floor plan offset; the current editor stores each unit’s vertical canvas coordinate in FloorPlanDesk.PositionY instead.

integer

required

Legacy floor-level value; Nexudus Floor Plan Editor layouts maintain the active level in FloorPlanLayout.FloorLevel instead.

number

required

Legacy decimal floor plan scale retained for older image-based records; the current editor does not expose or interpret this field.

Optional Fields

integer

ID of the optional Nexudus Floor Plan Editor layout associated with this floor plan; the layout must belong to a location the user can access.

string

URL of a new background/tracing image to upload. The image will be fetched and stored when the floor plan is saved.

boolean

Set to true to remove the current background/tracing image from this floor plan.

boolean

Whether the uploaded background image is displayed for an image-based floor plan.

integer

Optional maximum number of simultaneous bookings accepted across this floor plan; null means unlimited.

string

Integration-managed Archilogic scene GUID used to load the linked 3D floor plan; changing it can break the scene and unit mapping.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/floorplans" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "BackgroundScale": 0,
    "PositionX": 0,
    "PositionY": 0,
    "FloorLevel": 0,
    "Scale": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/floorplans',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'BackgroundScale': 0,
        'PositionX': 0,
        'PositionY': 0,
        'FloorLevel': 0,
        'Scale': 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 floorplan was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "FloorPlan 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
}

Create FloorPlan

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

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "BackgroundScale": 123,
    "PositionX": 123,
    "PositionY": 123,
    "FloorLevel": 123,
    "Scale": 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>',
    BackgroundScale: 123,
    PositionX: 123,
    PositionY: 123,
    FloorLevel: 123,
    Scale: 123
  })
};

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