Interface: IdLocation

Interface that represent a place with their id.

Example

// Resolve an internal alias that is reused across several malls by
// pinning the building (and, optionally, the floor) it belongs to.
const origin: IdLocation = {
  id: "store-204", // integrator alias, may repeat across buildings
  buildingId: "mall-santiago",
  floorId: "level-2", // takes precedence over `level`
}

Properties

buildingId?

optional buildingId: string;

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

Use this when IdLocation.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 IdLocation.buildingId) where the place is found.

This is only necessary if the place represented by the ID exists on multiple floors. Takes precedence over IdLocation.level when both are provided. If both are omitted and the place ID represents a place found on multiple floors, the first floor where this place is present will be used.

id

id: string

The ID of the place.

This 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), provide IdLocation.buildingId to disambiguate which building this place belongs to.

level?

optional level: number;

The level of the floor in the parent place where the place is found. This is only necessary if the place represented by the ID exists on multiple floors. If omitted and the place ID represents a place found on multiple floors, the first floor where this place is present will be used.

Prefer IdLocation.floorId when you have the floor ID; floorId takes precedence over level when both are provided.