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 FloorPlan is a visual diagram representing a single floor of a location. Floor plans are used by admins and customers to get an overview of the space layout, including rooms, desks, and other areas. Each floor plan belongs to a location (Business) and can optionally reference a FloorPlanLayout template. A background/tracing image can be uploaded to overlay the drawn areas, and its position and scale can be adjusted independently from the floor plan’s own scale. Once created, floor plan units (FloorPlanDesks) are added to the floor plan to represent individual bookable or non-bookable areas such as offices, dedicated desks, hot desks, and meeting rooms.

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 location this floor plan belongs to.

string

required

Display name of the floor plan (e.g. ‘Ground Floor’, ‘Level 2’).

integer

required

Zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size).

integer

required

Horizontal offset (in pixels) of the background image within the floor plan canvas.

integer

required

Vertical offset (in pixels) of the background image within the floor plan canvas.

integer

required

Floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement).

number

required

Real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit.

Optional Fields

integer

ID of the floor plan layout template to apply to this floor plan.

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 background/tracing image is visible when the floor plan is rendered.

integer

Maximum number of people this floor can accommodate at the same time.

string

Unique identifier used to link this floor plan to a corresponding Archilogic 3D model.

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
}

Update FloorPlanUpdate an existing FloorPlan record.

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