Occupant

Definition

An Occupant models the presence and location (via Anchor) of a business entity that trades goods and/or services.

  • Occupant objects are unlocated Features
  • Occupant objects MUST have an "id" member with a FEATURE-ID value
  • Occupant objects MUST have a "feature_type" member with the value "occupant"
  • Occupant objects MUST have a "geometry" member with a null value

Property Keys

Property Type Description
name LABELS The brand name for the Occupant.
category OCCUPANT-CATEGORY The category that best describes the function and/or service provided by the Occupant.
anchor_id ANCHOR-ID ID reference to Anchor record. Used to derive Unit, point location and Address (if present).
hours null or HOURS Hours of operation.
phone null or PHONE Main phone number.
website null or WEBSITE Website URL.
validity null or TEMPORALITY Information conveying the temporal validity of the Occupant.
correlation_id null or UUID Correlation ID shared among similar Occupant features that occupy different spaces of the physical Venue.

Example

{
  "id": "11111111-1111-1111-1111-111111111111",
  "type": "Feature",
  "feature_type": "occupant",
  "geometry": null,
  "properties": {
    "category": "restaurant",
    "name": {
      "en": "Example Restaurant"
    },
    "phone": "+12225551212",
    "website": "http://example.com",
    "hours": "Mo-Fr 08:30-20:00",
    "validity" : {
      "start": "2018-03-01T00:00:00+05:00",
      "end": "2018-10-01T11:59:59+05:00",
      "modified": "2018-01-01T12:34:56+05:00"
    },
    "anchor_id": "22222222-2222-2222-2222-222222222222",
    "correlation_id": null
  }
}

Property Capturing Rules

  • Zero or more Occupants MAY be positioned (via Anchor) within:
  • Multiple Occupants MAY reference the same Anchor if necessary.
  • Positioning (via Anchor) on a Level MUST be orderly/patterned to produce a desirable map aesthetic quality. (Illustration)
  • When multiple floors of a physical Venue are leased by the same business entity, a distinct Occupant feature MUST be positioned on each modeled Level.

NAME

  • MUST match the brand name of the business entity.

VALIDITY

All attribution contained in the "validity" object is intended to reflect the snapshot state of occupancy known or assumed to be true at the time of capture. This is particularly important for occupancy data intended for ongoing maintenance cycles in order to supply appropriate signals to consumers concerned with data recency and change detection, as these values are independent from the date/time of the archive's creation and delivery.

start

  • If the Occupant record will NOT be valid or available as captured until a known date/time, this value MUST be captured as the "start" value.
  • If the Occupant record is known to be valid or available at the time of capture (i.e. current state), the "start" value MUST be null.

end

  • If the Occupant record will become invalid or unavailable at a known date/time, this value MUST be captured as the "end" value.
  • If there is no known date/time at which the Occupant record will become invalid or unavailable as captured, the "end" value MUST be null.

modified

  • It is RECOMMENDED that the "modified" value reflect the date/time at which the Occupant record was captured or transferred from source material.
  • If no "modified" value is provided, the data consumer SHOULD consider the Occupant record as a snapshot state applicable only at the time of delivery.

CORRELATION_ID

Correlation ID shared by two or more distinct Occupant records modeling a single business entity that occupies multiple spaces on different floors of a Building. (Illustration 2)

  • MUST NOT be used to link Occupants representing the same business entity that are spatially distributed across a horizontal plane.

  • MUST be specified when ALL of the following conditions are present:

    • The Occupants are within Units that reference different Levels.
    • The occupied Units are within, overlap or equal to one another.
    • Only one Occupant is expected to be visible in a mapping application before a user selects a specific Level.

    "...within, overlap or equal to one another." is equivalent to the same business entity being physically above or physically below the pedestrian's standing position.