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, called a floor plan unit by operators, represents an office, desk, room, or other area on a location’s floor plan that can be assigned through contracts, connected to a bookable resource, and included in occupancy reporting.

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 required floor plan that owns this unit and determines its location.

string

required

Required, non-empty display name of the floor plan unit, such as ‘Office 3’ or ‘Hot Desk 12’.

integer

required

Type of unit: Office, DedicatedDesk, HotDesk, Other, or Room; AI private-office recommendations include only Office units.

number

required

Floor area stored in square metres; the Admin UI may display and convert it to square feet, and a linked layout area can overwrite it when SizeIsLinkedToArea is true.

number

required

Target number of seats for this unit, used for occupancy reporting and as a minimum-capacity filter in AI private-office recommendations.

number

required

Target price in the floor plan location’s currency for revenue occupancy reporting; it is not a billing price and is the AI price fallback when PriceForAi is null.

integer

required

Floor Plan Editor-managed horizontal canvas coordinate used to render this unit.

integer

required

Floor Plan Editor-managed vertical canvas coordinate used to render this unit.

integer

required

Floor Plan Editor-managed stacking order used to render overlapping units; higher values render on top.

Optional Fields

integer

ID of the optional customer occupying this unit; normally assign occupancy through a contract, and the customer cannot be changed while contracts are linked.

integer

ID of the optional IoT sensor whose latest reading and occupancy action are reported for this unit.

integer

ID of the optional bookable resource connected to this unit so customers can book it through a floor plan view.

boolean

Whether Size is synchronized from the Floor Plan Editor area identified by FloorPlanLayoutAssetUniqueId when that linked area exists.

string

Optional reporting group for floor plan units, such as a floor, zone, or wing.

string

Optional internal notes about this unit, limited to 255 characters and not visible to customers.

boolean

Whether this unit is in service and can be assigned to contracts or bookings; current availability also requires the UTC availability window to include now.

boolean

Whether AI channels may include this unit in private-office recommendations; the unit must also be an available Office.

string

Optional notes for AI recommendations, limited to 1,024 characters, such as accessibility, furnishing, natural light, or noise information.

boolean

Whether AI recommendations may show a price for this unit; this does not stop PriceForAi or Price from being used to match a customer’s budget.

number

Optional price override in the location’s currency used for AI display and budget matching; null falls back to Price.

string

Obsolete single-provider access-control group identifier retained as a fallback for legacy records; AccessControlGroupIds is the supported replacement.

string

Internal virtual LAN or RADIUS tunnel group identifier used by network integrations for this unit.

string

Inclusive UTC start of the reporting availability window; when omitted on create it defaults to the start of the current day at the location, and it must precede AvailableToTime when both are set.

string

Optional inclusive UTC end of the reporting availability window; null means no end, and it must follow AvailableFromTime when both are set.

string

Integration-managed Archilogic element GUID used to map this unit into a 3D scene; changing it can break scene synchronization.

string

Floor Plan Editor-managed area GUID that links this unit to a layout asset and drives linked Size synchronization.

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
}

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