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 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
    string
    Required
    Required
    Description
    Identifier of the project.

Query parameters

  • Name
    page
    Type
    integer
    Required
    Optional
    Description
    Page number to return (1-based, default 1).
  • Name
    pageSize
    Type
    integer
    Required
    Optional
    Description
    Number of top-level locations per page (default 1000, max 5000).

Response fields

  • Name
    locationViews
    Type
    array<object>
    Required
    Optional
    Description
    The top-level location views.
    • Name
      guid
      Type
      string
      Required
      Optional
      Description
      Identifier of the location. Matches the SpatialLocationId returned for products by the product query endpoint, so a product can be tied back to its location in this hierarchy.
    • 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.
      • Name
        set
        Type
        string
        Required
        Optional
        Description
        The name of the property set this property belongs to.
      • Name
        name
        Type
        string
        Required
        Optional
        Description
        The property name.
      • Name
        value
        Type
        string
        Required
        Optional
        Description
        The property value.
  • Name
    totalCount
    Type
    integer
    Required
    Optional
    Description
    Total number of top-level locations (before pagination).
  • Name
    page
    Type
    integer
    Required
    Optional
    Description
    The current page number (1-based).
  • Name
    pageSize
    Type
    integer
    Required
    Optional
    Description
    The maximum number of top-level locations returned per page.

Error responses

  • Name
    400
    Type
    application/json
    Description
    Bad Request

    Body: ErrorView

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

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
    string
    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
    "Site" | "Building" | "Floor" | "Space" | "Bridge" | "MarineFacility" | "Railway" | "Road" | "BridgePart" | "FacilityPartCommon" | "MarinePart" | "RailwayPart" | "RoadPart" | "Facility" | "ExternalSpatialElement" | "null"
    Required
    Optional
    Description
    Type of spatial location (Site, Building, Floor, Space, etc.).
  • Name
    parentGuid
    Type
    string
    Required
    Optional
    Description
    GUID of the parent spatial location. Null for top-level locations.

Response fields

  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    Identifier of the location. Matches the SpatialLocationId returned for products by the product query endpoint, so a product can be tied back to its location in this hierarchy.
  • 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
      guid
      Type
      string
      Required
      Optional
      Description
      Identifier of the location. Matches the SpatialLocationId returned for products by the product query endpoint, so a product can be tied back to its location in this hierarchy.
    • 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.
      • Name
        set
        Type
        string
        Required
        Optional
        Description
        The name of the property set this property belongs to.
      • Name
        name
        Type
        string
        Required
        Optional
        Description
        The property name.
      • Name
        value
        Type
        string
        Required
        Optional
        Description
        The property value.
  • Name
    properties
    Type
    array<object>
    Required
    Optional
    Description
    Custom properties attached to this location.
    • Name
      set
      Type
      string
      Required
      Optional
      Description
      The name of the property set this property belongs to.
    • Name
      name
      Type
      string
      Required
      Optional
      Description
      The property name.
    • Name
      value
      Type
      string
      Required
      Optional
      Description
      The property value.

Error responses

  • Name
    400
    Type
    application/problem+json
    Description
    Invalid request parameters or body

    Body: ProblemDetails

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

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

Get a single location by id

Returns the spatial location with the given id, including its nested child locations.

Path parameters

  • Name
    projectId
    Type
    string
    Required
    Required
    Description
    Identifier of the project.
  • Name
    locationGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the spatial location (e.g. a product query SpatialLocationId or SiteId/BuildingId/...).

Response fields

  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    Identifier of the location. Matches the SpatialLocationId returned for products by the product query endpoint, so a product can be tied back to its location in this hierarchy.
  • 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
      guid
      Type
      string
      Required
      Optional
      Description
      Identifier of the location. Matches the SpatialLocationId returned for products by the product query endpoint, so a product can be tied back to its location in this hierarchy.
    • 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.
      • Name
        set
        Type
        string
        Required
        Optional
        Description
        The name of the property set this property belongs to.
      • Name
        name
        Type
        string
        Required
        Optional
        Description
        The property name.
      • Name
        value
        Type
        string
        Required
        Optional
        Description
        The property value.
  • Name
    properties
    Type
    array<object>
    Required
    Optional
    Description
    Custom properties attached to this location.
    • Name
      set
      Type
      string
      Required
      Optional
      Description
      The name of the property set this property belongs to.
    • Name
      name
      Type
      string
      Required
      Optional
      Description
      The property name.
    • Name
      value
      Type
      string
      Required
      Optional
      Description
      The property value.

Error responses

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/json
    Description
    Not Found

    Body: ProblemDetails

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
    string
    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
    "Site" | "Building" | "Floor" | "Space" | "Bridge" | "MarineFacility" | "Railway" | "Road" | "BridgePart" | "FacilityPartCommon" | "MarinePart" | "RailwayPart" | "RoadPart" | "Facility" | "ExternalSpatialElement" | "null"
    Required
    Optional
    Description
    Type of spatial location (Site, Building, Floor, Space, etc.).
  • Name
    parentGuid
    Type
    string
    Required
    Optional
    Description
    GUID of the parent spatial location. Null for top-level locations.

Response fields

  • Name
    guid
    Type
    string
    Required
    Optional
    Description
    Identifier of the location. Matches the SpatialLocationId returned for products by the product query endpoint, so a product can be tied back to its location in this hierarchy.
  • 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
      guid
      Type
      string
      Required
      Optional
      Description
      Identifier of the location. Matches the SpatialLocationId returned for products by the product query endpoint, so a product can be tied back to its location in this hierarchy.
    • 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.
      • Name
        set
        Type
        string
        Required
        Optional
        Description
        The name of the property set this property belongs to.
      • Name
        name
        Type
        string
        Required
        Optional
        Description
        The property name.
      • Name
        value
        Type
        string
        Required
        Optional
        Description
        The property value.
  • Name
    properties
    Type
    array<object>
    Required
    Optional
    Description
    Custom properties attached to this location.
    • Name
      set
      Type
      string
      Required
      Optional
      Description
      The name of the property set this property belongs to.
    • Name
      name
      Type
      string
      Required
      Optional
      Description
      The property name.
    • Name
      value
      Type
      string
      Required
      Optional
      Description
      The property value.

Error responses

  • Name
    400
    Type
    application/problem+json
    Description
    Invalid request parameters or body

    Body: ProblemDetails

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

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
    string
    Required
    Required
    Description
    Identifier of the project.
  • Name
    locationGuid
    Type
    string
    Required
    Required
    Description
    Identifier of the spatial location.

Error responses

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

  • Name
    404
    Type
    application/problem+json
    Description
    The requested resource was not found

    Body: ProblemDetails

‹
Previous
Projects
›
Next
Types