Interface: PlaceQuery

Query used to look up a single place.

The PlaceQuery.id can be an internal alias defined by the integrator. Because aliases are not guaranteed to be globally unique (the same alias may be reused across different buildings/venues, e.g. the same store alias present in several shopping malls), provide PlaceQuery.buildingId —and optionally PlaceQuery.floorId— to disambiguate which place the alias refers to.

This mirrors the disambiguation already available for routes via IdLocation.

Example

// Resolve an alias reused across several malls by pinning the building.
const query: PlaceQuery = {
  id: "store-204", // integrator alias, may repeat across buildings
  buildingId: "mall-santiago",
  floorId: "level-2", // optional; takes precedence over `level`
}

Properties

buildingId?

optional buildingId: string;

The ID of the building (parent venue) that contains the place referenced by PlaceQuery.id.

Use this when PlaceQuery.id is an internal alias that may be repeated across multiple buildings (e.g. the same store alias present in several shopping malls). Providing the building ID resolves the alias to the correct venue. If omitted, the alias is resolved without building context, which may be ambiguous when the alias is shared by more than one building.

floorId?

optional floorId: string;

The ID of the floor (within PlaceQuery.buildingId) where the place is found. Only necessary if the place exists on multiple floors. Takes precedence over PlaceQuery.level when both are provided.

id

id: string

The ID of the place. May be an internal alias that is not globally unique.

level?

optional level: number;

The numeric level of the floor where the place is found. Alternative to PlaceQuery.floorId; floorId takes precedence when both are provided.