Spatial Locations

The location library contains all spatial locations in the project: Sites, Buildings, Floors, Spaces and other types of locations. For more information about spatial locations, visit our help page here.

The location object

The location object contains all the information about a spatial location, such as their locationGuid, name, type and parentGuid.

Properties

  • Name
    locationGuid
    Type
    string
    Description
    The Global Unique identifier for the location.
  • Name
    projectId
    Type
    string
    Description
    The ID of the project the location belongs to.
  • Name
    name
    Type
    string
    Description
    The name of the location.
  • Name
    type
    Type
    "Site" | "Building" | "Floor" | "Space" | "Bridge" | "MarineFacility" | "Railway" | "Road" | "BridgePart" | "FacilityPartCommon" | "MarinePart" | "RailwayPart" | "RoadPart" | "Facility" | "ExternalSpatialElement"
    Description
    The type of the location.
  • Name
    parentGuid
    Type
    string
    Description
    The Global Unique Identifier of the parent of the location.
GET https://api.qonic.com/v1/projects/:projectId/locations

List all spatial locations

This endpoint allows you to retrieve a list of all locations in a specific project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to retrieve locations from.
POST https://api.qonic.com/v1/projects/:projectId/locations

Create a spatial location

This endpoint allows you to create a new location in a project.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project to create the location in.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the location.
  • Name
    type
    Type
    "Site" | "Building" | "Floor" | "Space" | "Bridge" | "MarineFacility" | "Railway" | "Road" | "BridgePart" | "FacilityPartCommon" | "MarinePart" | "RailwayPart" | "RoadPart" | "Facility" | "ExternalSpatialElement"
    Description
    The type of the location.
  • Name
    parentGuid
    Type
    string
    Description
    The Global Unique Identifier of the parent of the location.
PUT https://api.qonic.com/v1/projects/:projectId/locations/:locationGuid

Update a spatial location

This endpoint allows you to update an existing spatial location.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the location.
  • Name
    locationGuid
    Type
    string
    Description
    The Guid of the location to update.

Optional parameters

  • Name
    name
    Type
    string
    Description
    The name of the location.
  • Name
    type
    Type
    "Site" | "Building" | "Floor" | "Space" | "Bridge" | "MarineFacility" | "Railway" | "Road" | "BridgePart" | "FacilityPartCommon" | "MarinePart" | "RailwayPart" | "RoadPart" | "Facility" | "ExternalSpatialElement"
    Description
    The type of the location.
  • Name
    parentGuid
    Type
    string
    Description
    The Global Unique Identifier of the parent of the location.
DELETE https://api.qonic.com/v1/projects/:projectId/locations/:locationGuid

Delete a spatial location

This endpoint allows you to permanently delete a spatial location from a project. This action cannot be undone.

Path parameters

  • Name
    projectId
    Type
    string
    Description
    The ID of the project containing the spatial location.
  • Name
    locationGuid
    Type
    string
    Description
    The Guid of the location to delete.
‹
Previous
Material
›
Next
Type