Skip to main content

Floors

Available on NTController.floors.

floors.update(id, body)

PATCH /api/v1/floors/{id}

FieldTypeDescription
namestringDisplay name, such as "Ground floor".
numbernumberOrdering index within the tour.

Returns void

await NTController.floors.update(floorId, { name: "Ground floor" });

floors.delete(id)

DELETE /api/v1/floors/{id}

Deletes a floor together with its rooms and scans.

Returns void

floors.getPlanUploadURL(id)

POST /api/v1/floors/{id}/upload

Issues a presigned POST target for this floor's plan document. Use uploadPlan unless you need to drive the upload yourself.

Returns PresignedUpload

floors.uploadPlan(id, document)

Requests a presigned target and sends the document straight to storage, so the file never passes through the API. The document is JSON.

ParameterTypeDescription
id (required)stringFloor identifier.
document (required)stringSerialized floor-plan JSON. Maximum 1 MB.

Returns void

await NTController.floors.uploadPlan(floorId, JSON.stringify(plan));
note

A document over 1 MB rejects with a plain Error before any request is sent, rather than failing against the storage policy afterwards.