Create FloorPlanDeskVariant

POST

api

sys

floorplandeskvariants

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplandeskvariants \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FloorPlanDeskId": 123,
  "Name": "<string>",
  "OccupancyPercentage": 123
}
'

import requests

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

payload = {
    "FloorPlanDeskId": 123,
    "Name": "<string>",
    "OccupancyPercentage": 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({FloorPlanDeskId: 123, Name: '<string>', OccupancyPercentage: 123})
};

fetch('https://spaces.nexudus.com/api/sys/floorplandeskvariants', 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 FloorPlanDeskVariant, called a Package by operators, defines how a location’s floor plan unit can be contracted under different availability, setup, or pricing conditions. Packages can split an office between customers on different weekdays, or offer the same unit as a private office (full-time or fractional), storage unit, or event 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 FloorPlanDeskVariant-Create role.

Request Body

Required Fields

integer

required

ID of the required floor plan unit this variant configures; the unit determines the owning location.

string

required

Required, non-empty display name for this alternate floor plan unit configuration.

number

required

Percentage of the floor plan unit’s total possible use reported when this package is contracted; normally divide use evenly across packages according to the number of weekdays each is available.

Optional Fields

integer

ID of the optional customer this variant is associated with.

number

Optional floor area in square metres for this configuration.

number

Optional number of seats this configuration can accommodate.

number

Optional target price in the owning location’s currency, used for occupancy reporting rather than billing.

string

Optional internal notes about this configuration, limited to 255 characters.

boolean

Whether this configuration is marked available on Monday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Whether this configuration is marked available on Tuesday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Whether this configuration is marked available on Wednesday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Whether this configuration is marked available on Thursday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Whether this configuration is marked available on Friday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Whether this configuration is marked available on Saturday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

boolean

Whether this configuration is marked available on Sunday; scheduling conflict checks treat matching enabled weekday flags as overlapping.

string

Obsolete single-provider access-control group identifier retained for legacy records; do not set it through floor plan administration.

string

Optional inclusive UTC start of this configuration’s availability window; it must precede AvailableToTime when both are set.

string

Optional inclusive UTC end of this configuration’s availability window; null means no end, and it must follow AvailableFromTime when both are set.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/floorplandeskvariants" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "FloorPlanDeskId": 0,
    "Name": "",
    "OccupancyPercentage": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/floorplandeskvariants',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'FloorPlanDeskId': 0,
        'Name': '',
        'OccupancyPercentage': 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 floorplandeskvariant was created successfully.

array

null on success.

Example Response

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

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/floorplandeskvariants \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FloorPlanDeskId": 123,
  "Name": "<string>",
  "OccupancyPercentage": 123
}
'

import requests

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

payload = {
    "FloorPlanDeskId": 123,
    "Name": "<string>",
    "OccupancyPercentage": 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({FloorPlanDeskId: 123, Name: '<string>', OccupancyPercentage: 123})
};

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