Get one FloorPlanDeskVariant

GET

api

sys

floorplandeskvariants

{id}

Get one FloorPlanDeskVariant

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplandeskvariants/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplandeskvariants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "FloorPlanDeskId": 123,
  "FloorPlanDeskName": "<string>",
  "FloorPlanDeskPrice": 123,
  "FloorPlanDeskFloorPlanId": 123,
  "FloorPlanDeskFloorPlanName": "<string>",
  "FloorPlanDeskFloorPlanBusinessId": 123,
  "FloorPlanDeskFloorPlanBusinessName": "<string>",
  "FloorPlanDeskFloorPlanBusinessCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerTeamNames": "<string>",
  "Name": "<string>",
  "Size": 123,
  "Capacity": 123,
  "Price": 123,
  "OccupancyPercentage": 123,
  "Notes": "<string>",
  "AvailableMonday": true,
  "AvailableTuesday": true,
  "AvailableWednesday": true,
  "AvailableThursday": true,
  "AvailableFriday": true,
  "AvailableSaturday": true,
  "AvailableSunday": true,
  "AccessControlGroupId": "<string>",
  "CoworkerContractIds": "<string>",
  "CoworkerContractFullNames": "<string>",
  "CoworkerContractStartDates": "<string>",
  "AvailableFromTime": "<string>",
  "AvailableToTime": "<string>",
  "AvailableFromTimeLocal": "<string>",
  "AvailableToTimeLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

Path Parameters

integer

required

The Id of the FloorPlanDeskVariant record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandeskvariants/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandeskvariants/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandeskvariants/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

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

string

Display value for FloorPlanDesk.Name..

number

Display value for FloorPlanDesk.Price..

integer

Display value for FloorPlanDesk.FloorPlan.Id..

string

Display value for FloorPlanDesk.FloorPlan.Name..

integer

Display value for FloorPlanDesk.FloorPlan.Business.Id..

string

Display value for FloorPlanDesk.FloorPlan.Business.Name..

string

Display value for FloorPlanDesk.FloorPlan.Business.Currency.Code..

integer

ID of the optional customer this variant is associated with.

string

Display value for Coworker.FullName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.Email..

string

Display value for Coworker.TeamNames..

string

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

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.

number

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.

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

Read-only denormalized IDs of contracts linked to this configuration; update the contracts rather than this projection.

string

Read-only denormalized customer names from contracts linked to this configuration; update the contracts rather than this projection.

string

Read-only denormalized start dates from contracts linked to this configuration; update the contracts rather than this projection.

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.

string

Derived location-local representation of AvailableFromTime populated by date-localization infrastructure; change AvailableFromTime instead.

string

Derived location-local representation of AvailableToTime populated by date-localization infrastructure; change AvailableToTime instead.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "FloorPlanDeskId": 0,
  "FloorPlanDeskName": null,
  "FloorPlanDeskPrice": null,
  "FloorPlanDeskFloorPlanId": null,
  "FloorPlanDeskFloorPlanName": null,
  "FloorPlanDeskFloorPlanBusinessId": null,
  "FloorPlanDeskFloorPlanBusinessName": null,
  "FloorPlanDeskFloorPlanBusinessCurrencyCode": null,
  "CoworkerId": null,
  "CoworkerFullName": null,
  "CoworkerCompanyName": null,
  "CoworkerCoworkerType": null,
  "CoworkerEmail": null,
  "CoworkerTeamNames": null,
  "Name": "",
  "Size": null,
  "Capacity": null,
  "Price": null,
  "OccupancyPercentage": 0,
  "Notes": null,
  "AvailableMonday": false,
  "AvailableTuesday": false,
  "AvailableWednesday": false,
  "AvailableThursday": false,
  "AvailableFriday": false,
  "AvailableSaturday": false,
  "AvailableSunday": false,
  "AccessControlGroupId": null,
  "CoworkerContractIds": null,
  "CoworkerContractFullNames": null,
  "CoworkerContractStartDates": null,
  "AvailableFromTime": null,
  "AvailableToTime": null,
  "AvailableFromTimeLocal": null,
  "AvailableToTimeLocal": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "FloorPlanDeskVariant Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one FloorPlanDeskVariant

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplandeskvariants/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplandeskvariants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "FloorPlanDeskId": 123,
  "FloorPlanDeskName": "<string>",
  "FloorPlanDeskPrice": 123,
  "FloorPlanDeskFloorPlanId": 123,
  "FloorPlanDeskFloorPlanName": "<string>",
  "FloorPlanDeskFloorPlanBusinessId": 123,
  "FloorPlanDeskFloorPlanBusinessName": "<string>",
  "FloorPlanDeskFloorPlanBusinessCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerTeamNames": "<string>",
  "Name": "<string>",
  "Size": 123,
  "Capacity": 123,
  "Price": 123,
  "OccupancyPercentage": 123,
  "Notes": "<string>",
  "AvailableMonday": true,
  "AvailableTuesday": true,
  "AvailableWednesday": true,
  "AvailableThursday": true,
  "AvailableFriday": true,
  "AvailableSaturday": true,
  "AvailableSunday": true,
  "AccessControlGroupId": "<string>",
  "CoworkerContractIds": "<string>",
  "CoworkerContractFullNames": "<string>",
  "CoworkerContractStartDates": "<string>",
  "AvailableFromTime": "<string>",
  "AvailableToTime": "<string>",
  "AvailableFromTimeLocal": "<string>",
  "AvailableToTimeLocal": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200