Spatial Locations

Manage spatial locations (building stories, zones, spaces) within projects. Define the spatial hierarchy of your building.

GET https://api.qonic.com/v1/projects/:projectId/locations

Get all locations

Returns the full spatial location hierarchy for the project, including nested child locations. Use this to retrieve the building structure (e.g. site, building, storey).

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.

Response fields

  • Name
    locationViews
    Type
    array<object>
    Required
    Optional
    Description
    The top-level location views.

Error responses

  • Name
    400
    Type
    error
    Description
    Bad Request
  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
  • Name
    404
    Type
    error
    Description
    The requested resource was not found
POST https://api.qonic.com/v1/projects/:projectId/locations

Create spatial location

Creates a new top-level spatial location in the project, such as a site, building, or storey. The X-Client-Session-Id header is required.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.

Request body

  • Name
    name
    Type
    string
    Required
    Required
    Description
    Display name of the spatial location.
  • Name
    type
    Type
    any
    Required
    Optional
    Description
  • Name
    parentGuid
    Type
    string
    Required
    Optional
    Description
    GUID of the parent spatial location. Null for top-level locations.

Response fields

  • Name
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the location.
  • Name
    children
    Type
    array<object>
    Required
    Optional
    Description
    Child locations nested under this location.
  • Name
    properties
    Type
    array<object>
    Required
    Optional
    Description
    Custom properties attached to this location.

Error responses

  • Name
    400
    Type
    error
    Description
    Invalid request parameters or body
  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
  • Name
    404
    Type
    error
    Description
    The requested resource was not found
PUT https://api.qonic.com/v1/projects/:projectId/locations/:locationGuid

Update spatial location

Updates the properties of an existing spatial location. Use this to rename or modify a location's attributes. The X-Client-Session-Id header is required.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.
  • Name
    locationGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the spatial location.

Request body

  • Name
    name
    Type
    string
    Required
    Required
    Description
    Display name of the spatial location.
  • Name
    type
    Type
    any
    Required
    Optional
    Description
  • Name
    parentGuid
    Type
    string
    Required
    Optional
    Description
    GUID of the parent spatial location. Null for top-level locations.

Response fields

  • Name
    name
    Type
    string
    Required
    Optional
    Description
    The display name of the location.
  • Name
    children
    Type
    array<object>
    Required
    Optional
    Description
    Child locations nested under this location.
  • Name
    properties
    Type
    array<object>
    Required
    Optional
    Description
    Custom properties attached to this location.

Error responses

  • Name
    400
    Type
    error
    Description
    Invalid request parameters or body
  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
  • Name
    404
    Type
    error
    Description
    The requested resource was not found
DELETE https://api.qonic.com/v1/projects/:projectId/locations/:locationGuid

Delete spatial location

Permanently removes a spatial location and all its child locations from the project. The X-Client-Session-Id header is required.

Path parameters

  • Name
    projectId
    Type
    integer
    Required
    Required
    Description
    Identifier of the project.
  • Name
    locationGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the spatial location.

Error responses

  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
  • Name
    404
    Type
    error
    Description
    The requested resource was not found
‹
Previous
Sessions
›
Next
Tool Hub