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 defines an alternative visual representation or configuration for a desk on a floor plan. Variants allow the same desk to be displayed differently based on context or state.

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 floor plan desk linked to this record.

string

required

The name value for this floor plan desk variant.

number

required

The occupancy percentage value for this floor plan desk variant.

Optional Fields

integer

ID of the coworker linked to this record.

number

The size value for this floor plan desk variant.

number

The capacity value for this floor plan desk variant.

number

Unit price amount.

string

Optional notes or comments about this floor plan desk variant.

boolean

Whether available monday is enabled.

boolean

Whether available tuesday is enabled.

boolean

Whether available wednesday is enabled.

boolean

Whether available thursday is enabled.

boolean

Whether available friday is enabled.

boolean

Whether available saturday is enabled.

boolean

Whether available sunday is enabled.

string

ID of the access control group associated with this record.

string

The coworker contract ids value for this floor plan desk variant.

string

The coworker contract full names value for this floor plan desk variant.

string

The coworker contract start dates value for this floor plan desk variant.

string

Date/time value for available from time.

string

Date/time value for available to time.

string

Date/time value for available from time local.

string

Date/time value for available to time local.

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
}

Update FloorPlanDeskVariantUpdate an existing FloorPlanDeskVariant record.

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