Create FloorPlanDesk

POST

api

sys

floorplandesks

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplandesks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FloorPlanId": 123,
  "Name": "<string>",
  "ItemType": 123,
  "Size": 123,
  "Capacity": 123,
  "Price": 123,
  "PositionX": 123,
  "PositionY": 123,
  "PositionZ": 123
}
'

import requests

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

payload = {
    "FloorPlanId": 123,
    "Name": "<string>",
    "ItemType": 123,
    "Size": 123,
    "Capacity": 123,
    "Price": 123,
    "PositionX": 123,
    "PositionY": 123,
    "PositionZ": 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({
    FloorPlanId: 123,
    Name: '<string>',
    ItemType: 123,
    Size: 123,
    Capacity: 123,
    Price: 123,
    PositionX: 123,
    PositionY: 123,
    PositionZ: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/floorplandesks', 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 FloorPlanDesk (referred to as a floor plan unit in the UI) represents a specific area or room placed on a floor plan. Each unit typically maps to a bookable resource or a space assigned to a customer through a contract. There are five unit types controlled by ItemType:

ItemType	Typical use
Office	Private office assigned to a customer via a contract
DedicatedDesk	Desk permanently assigned to a customer via a contract
HotDesk	Shared desk bookable via a resource or assigned to a contract
Room	Meeting room or bookable space linked to a resource
Other	Any area that does not match the types above

Link a unit to a Resource via ResourceId to let customers book it through the floor plan view on the Members Portal. Assign it to one or more contracts via CoworkerContractIds to track occupancy. Units can be monitored by an IoT sensor (SensorId). The last sensor reading is exposed via SensorLastValue and IsSensorOccupied. Position and size on the canvas are maintained by the floor plan editor. AvailableFromTime / AvailableToTime allow time-bounded availability windows.

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

Enums

eFloorPlanItemType — ItemType values

Value	Name
1	Office
2	DedicatedDesk
3	HotDesk
4	Other
5	Room

eCoworkerRecordType

Value	Name
1	Individual
2	Company

eSensorType

Value	Name
1	PresenceDetection
2	PeopleCounter
3	Temperature
4	Humidity
5	Light
6	Noise
7	CO2
8	VolatileOrganicCompounds
9	HarmfulParticulates
10	Touch
11	Water
12	AtmosphericPressure
13	Power
14	OpenClosed
99	Other

Request Body

Required Fields

integer

required

ID of the floor plan this unit belongs to.

string

required

Display name of the floor plan unit (e.g. ‘Office 3’, ‘Hot Desk 12’).

integer

required

Type of area this unit represents: Office, DedicatedDesk, HotDesk, Room, or Other.

number

required

Floor area of this unit (e.g. in sq ft or sq m, depending on the location’s unit setting).

number

required

Number of people this unit can accommodate at the same time.

number

required

Indicative price displayed on the floor plan view (informational only; actual billing is handled by products and contracts).

integer

required

X coordinate of this unit’s position on the floor plan canvas.

integer

required

Y coordinate of this unit’s position on the floor plan canvas.

integer

required

Z-index (draw order) of this unit on the floor plan canvas; higher values render on top.

Optional Fields

integer

ID of the customer assigned to this unit (used for dedicated desks and offices).

integer

ID of the IoT sensor monitoring occupancy or environmental conditions in this unit.

integer

ID of the bookable resource linked to this unit, enabling customers to book it via the floor plan view.

boolean

When true, the Size value is automatically calculated from the drawn shape area on the floor plan canvas.

string

Computed area of the drawn shape on the floor plan canvas, set automatically by the editor.

string

Internal notes about this unit, visible to admins only.

boolean

Whether this unit is currently available for assignment or booking.

boolean

Whether this unit is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.

string

Notes or instructions for AI channels to consider when recommending this unit for private offices (e.g. ‘great natural light but a bit noisy’).

boolean

Whether to show the price of this unit in AI channel recommendations and responses based on users’ budget preferences.

number

Override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used).

string

Access control group identifier that governs door/entry access for this unit.

string

Network tunnel group identifier for private network access scoped to this unit.

string

Comma-separated list of contract IDs currently assigned to this unit.

string

Comma-separated list of customer names from contracts assigned to this unit.

string

Comma-separated list of start dates for contracts assigned to this unit.

string

UTC date/time from which this unit becomes available.

string

UTC date/time until which this unit is available.

string

Local date/time from which this unit becomes available (derived from AvailableFromTime).

string

Local date/time until which this unit is available (derived from AvailableToTime).

string

Unique identifier linking this unit to its corresponding element in an Archilogic 3D model.

string

Unique identifier linking this unit to a component in the associated floor plan layout template.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/floorplandesks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "FloorPlanId": 0,
    "Name": "",
    "ItemType": 0,
    "Size": 0,
    "Capacity": 0,
    "Price": 0,
    "PositionX": 0,
    "PositionY": 0,
    "PositionZ": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandesks',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      FloorPlanId: 0,
      Name: '',
      ItemType: 0,
      Size: 0,
      Capacity: 0,
      Price: 0,
      PositionX: 0,
      PositionY: 0,
      PositionZ: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/floorplandesks',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'FloorPlanId': 0,
        'Name': '',
        'ItemType': 0,
        'Size': 0,
        'Capacity': 0,
        'Price': 0,
        'PositionX': 0,
        'PositionY': 0,
        'PositionZ': 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 floorplandesk was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "FloorPlanDesk 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 FloorPlanDeskUpdate an existing FloorPlanDesk record.

Create FloorPlanDesk

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplandesks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FloorPlanId": 123,
  "Name": "<string>",
  "ItemType": 123,
  "Size": 123,
  "Capacity": 123,
  "Price": 123,
  "PositionX": 123,
  "PositionY": 123,
  "PositionZ": 123
}
'

import requests

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

payload = {
    "FloorPlanId": 123,
    "Name": "<string>",
    "ItemType": 123,
    "Size": 123,
    "Capacity": 123,
    "Price": 123,
    "PositionX": 123,
    "PositionY": 123,
    "PositionZ": 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({
    FloorPlanId: 123,
    Name: '<string>',
    ItemType: 123,
    Size: 123,
    Capacity: 123,
    Price: 123,
    PositionX: 123,
    PositionY: 123,
    PositionZ: 123
  })
};

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

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400