Get one FloorPlanLayout

GET

api

sys

floorplanlayouts

{id}

Get one FloorPlanLayout

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

import requests

url = "https://spaces.nexudus.com/api/sys/floorplanlayouts/{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/floorplanlayouts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "Name": "<string>",
  "BackgroundImageFileName": "<string>",
  "NewBackgroundImageUrl": "<string>",
  "ClearBackgroundImageFile": true,
  "Size": 123,
  "TracingImageFileName": "<string>",
  "NewTracingImageUrl": "<string>",
  "ClearTracingImageFile": true,
  "PreviewImageFileName": "<string>",
  "NewPreviewImageUrl": "<string>",
  "ClearPreviewImageFile": true,
  "BackgroundImageScale": 123,
  "TracingImageScale": 123,
  "FloorLevel": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A FloorPlanLayout represents the overall layout configuration of a floor plan, including its dimensions, background image, and visual settings. Each floor plan can have one or more layouts to represent different configurations of the same 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 FloorPlanLayout-Read role.

Path Parameters

integer

required

The Id of the FloorPlanLayout record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Display name of the linked business (read-only).

string

The business currency code value for this floor plan layout.

string

The name value for this floor plan layout.

string

Current file name of the background image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the background image.

boolean

Set to true to remove the current background image file.

number

The size value for this floor plan layout.

string

Current file name of the tracing image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the tracing image.

boolean

Set to true to remove the current tracing image file.

string

Current file name of the preview image (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the preview image.

boolean

Set to true to remove the current preview image file.

integer

The background image scale value for this floor plan layout.

integer

The tracing image scale value for this floor plan layout.

integer

The floor level value for this floor plan layout.

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

{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessCurrencyCode": null,
  "Name": "",
  "BackgroundImageFileName": null,
  "NewBackgroundImageUrl": null,
  "ClearBackgroundImageFile": null,
  "Size": 0,
  "TracingImageFileName": null,
  "NewTracingImageUrl": null,
  "ClearTracingImageFile": null,
  "PreviewImageFileName": null,
  "NewPreviewImageUrl": null,
  "ClearPreviewImageFile": null,
  "BackgroundImageScale": 0,
  "TracingImageScale": 0,
  "FloorLevel": 0,
  "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": "FloorPlanLayout Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple FloorPlanLayoutsRetrieve multiple FloorPlanLayout records by their Ids in a single request.

Get one FloorPlanLayout

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

import requests

url = "https://spaces.nexudus.com/api/sys/floorplanlayouts/{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/floorplanlayouts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "Name": "<string>",
  "BackgroundImageFileName": "<string>",
  "NewBackgroundImageUrl": "<string>",
  "ClearBackgroundImageFile": true,
  "Size": 123,
  "TracingImageFileName": "<string>",
  "NewTracingImageUrl": "<string>",
  "ClearTracingImageFile": true,
  "PreviewImageFileName": "<string>",
  "NewPreviewImageUrl": "<string>",
  "ClearPreviewImageFile": true,
  "BackgroundImageScale": 123,
  "TracingImageScale": 123,
  "FloorLevel": 123,
  "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