Module place

Package com.here.mom.feature.place

Features

Parts

Enums

AirportType

enum AirportType

Module place

Value Description
UNDEFINED
TERMINAL

AssociationType

enum AssociationType

Module place

Value Description
UNDEFINED
PHYSICAL
LOGICAL
IDENTITY
LOCATION
PREFERRED
SUGGESTED
EXCLUSIVE
PRIVATE

CampSiteType

enum CampSiteType

Module place

Value Description
UNDEFINED
TENT
CABIN
RECREATIONAL_VEHICLE

ContactItem

part ContactItem

Module place

Property Type Modifier Description
contactType ContactType optional Contact Type indicates type of contact information available for a POI.
value string optional Value is the actual detail which correspond to the respective contact type.

E.g. Phone Number/URL/Email Address.
preferred boolean optional Preferred inidcates the primary contact for a particular POI.
phoneNumber PhoneNumber optional Phone number with components (Country Code, Area Code Local Number).

ContactType

enum ContactType

Module place

Value Description
UNDEFINED
TOLLFREE
PHONE
MOBILE
URL
EMAIL
FAX
OTHER

EntranceType

enum EntranceType

Module place

Value Description
UNDEFINED
PREFERRED

Feedback

part Feedback

Module place

User feedback for the place.

Property Type Modifier Description
userId string User-id providing the feedpack.
supplierId string The id of the feedback supplier.
reviews Review set Reviews provided by the user.

FeedbackSummary

part FeedbackSummary

Module place

Summary of feedback.

Property Type Modifier Description
supplierId string The id of the review and rating supplier.
reviewSummary ReviewSummary optional Summary of the reviews.
ratingSummary RatingSummary optional Summary of the ratings.

Fuel

part Fuel

Module place

Type of Fuel applicable for a Petrol/Gasoline Station. The fuel type determines whether or not a pertrol/gas station sells a particular fuel.

Property Type Modifier Description
cng boolean optional Compressed Natural Gas (CNG) indicates whether or not a petrol/gas station sells cng fuel.
lpg boolean optional Liquefued Petroleum Gas (LPG) indicates whether or not a petrol/gas station sells lpg fuel.
e85 boolean optional Ethanol Fuel (E85) indicates whether or not a petrol/gas station sells E85 fuel.
bioDiesel boolean optional BioDiesel indicates whether or not a petrol/gas station sells biodiesel fuel.
diesel boolean optional Diesel indicates whether or not a petrol/gas station sells diesel fuel.
dieselAdditive boolean optional DieselAdditive whether or not a petrol/gas station sells diesel additive fuel.
gasoline boolean optional Gasoline indicates whether or not a petrol/gas station sells gasoline fuel.
lng boolean optional Liquefied Natural Gas indicates whether or not a petrol/gas station sells lng fuel.
hydrogen boolean optional Hydrogen indicates whether or not a petrol/gas station sells hydrogen fuel.
hydrogenPressures integer list available pressures in bar

Location

part Location

Module place

Generated anonymous type: Location from: locations + items

Property Type Modifier Description
type PlaceLocationType optional Location Type defines the actual classification of the location.
isPrimary boolean optional Primary Location indicates that the location is the primary location determined by HERE.
label string optional POI Label contains any general label for contact information.
sourceAddress AddressProperties optional Source Address showcases the detail address of a POI.

Point Address represents an individual address as a point object.

Micro Addrress represents additional information such as Floor number, Suite number etc.

OutdoorActivity

enum OutdoorActivity

Module place

Value Description
UNDEFINED
CAMPING_HORSEBACK_RIDING
RUNNING_WALKING_HIKING
SKIING_SNOWBOARDING_XC_SKIING
MOUNTAIN_BIKING_BMX_BIKING
FISHING_BOATING
SURFING
CANOEING_RAFTING_KAYAKING

PhoneNumber

part PhoneNumber

Module place

Phone Number with components

Property Type Modifier Description
countryCode string Country telephone code comprising a non-empty string of digits.
areaCode string optional Optional area code comprising digits only.
localNumber string Local number comprising a non-empty string of digits.
Constraint Expression Description
countryCodeMatches0_9 match(.countryCode, "[0-9]+")
areaCodeMatches0_9 (non-empty(.areaCode) -> match(head(.areaCode), "[0-9]+"))
localNumberMatches0_9 match(.localNumber, "[0-9]+")

Place

feature Place extends MomFeature

Module place

Definition of a Place in Map Objects schema

Property Type Modifier Description
momType "Place"
id string
bbox BoundingBox optional
geometry Point
properties PlaceProperties
referencePoint Point optional This is the location of this feature, collapsed to a single point.

This is for any application where an approximate, but deterministic and consistent, location is useful. One

example is deciding where to "anchor" a feature within a tiled map database.

Any Reference to this feature should include this point.
nonSpatialPartitionKey string optional The partition id for a generically partitioned feature.

Generically partitioned features fall into two categories:

1. Features that have a spatial component but may not make sense to partition based on that geometry.

2. Features that don't have a strong spatial component.

How keys will be assigned and what value ranges will be used are not specified.

Examples of generically partitioned features are admin, zone, postal, phonetics, metadata, etc.
Constraint Expression Description
atMostOneDefinedProperty (is-empty(.referencePoint) is-empty(.nonSpatialPartitionKey)) At most one of non-spatial-partition-key and reference-point can be defined.

PlaceAssociation

part PlaceAssociation

Module place

Property Type Modifier Description
parent MomFeature The Place association, parent place ID
associationType AssociationType The Place association Type, There are three association types : P = Physical, L = Logical ; I-Identity

PlaceProperties

part PlaceProperties extends Common

Module place

Generated replace type at: /definitions/mom.Place/definitions/Place/properties/properties

Property Type Modifier Description
@ns:com:here:mom:meta Metadata optional
@ns:com:here:mom:rmob string optional Currently not specified - may be specified by each Feature individually in future
featureType FeatureType optional Deprecated. This property is redundant to MomFeature.momType and should not be used.

MOM clients before 2.6 release had this deprecated property set to required, so

if data needs to be JSON schema validated by clients before 2.6 this property must be

set by the writer.
isoCountryCode Country optional Deprecated. This indicates which country a Feature is in, with a couple caveats.

- It may be unknown ("NONE" is a valid value, in addition to "UNDEFINED" like all MOM enums) simply because the

writer has not tried to figure it out or has otherwise not had the means to do so.

- It may be outright incorrect or a simplification of reality, specifically when a Feature is close to a country

border or in a disputed area (e.g., two or more countries claim the same area).

In all cases, writers and readers of this data should understand that the semantics of this property must be

agreed upon (if it is used at all). The preferred method of relating a Feature to a Country is through a

(direct or transitive) Reference from the Feature to an Admin.
@ns:com:here:mom:delta Branch optional
@ns:com:here:mom:mapcreator MapCreator optional
@ns:com:here:xyz Xyz optional Generic Data Hub namespace
extensionOSM MomOsm optional Optional extension for OSM (Open Street Map) metadata,

in case the object came from OSM
@ns:com:here:groundTruth GroundTruth optional Ground truth namespace
confidence ConfidenceData optional Confidence of a feature, optional only for the features

that are not participating in Quality Index.
categories string set Categories associated with this place.
wheelchairAccess integer optional Wheelchair Access indicates accessibility for persons with disablities (mainly wheelchair bound) at a business

resperesented by the place.

Integer mapping for WheelchairAccess are as follows:

1 = False (The facility is not accessible for wheelchair-bound persons.)

2 = Limited (The facility is not totally wheelchair friendly, e.g. steep ramps, split level floors, etc.)

3 = True (The facility is fully equipped for handicap access.)
locations Location list Location showcases the various details pertaining to POI such as location type, primary location, address, etc.
qualityLevel integer optional Quality Level reflects HERE's confidence that a Place is real Place.

For quality level it ranges from 1 to 5, where 5 represents the highest confidence.
pois Poi list Showcases various attributes pertaining to a particular Place/POI.
status Status optional Status indicates whether a particular Place/POI is active, inactive, seasonal for business.
pools Pool list Electric Vehicle Charging Pool. A Pool is a grouping of charging stations that share close location.
extEvCharging EvcsCharging (Deprecated) optional Deprecated. Replaced by pools to comply with eMI³ standard.
names Name list POI Name is the name by which the POI is known.
isValidUnnamed boolean optional Indicates whether the absence of names is valid or not.

If the collection of names on this feature is non-empty, then this should not be set.

If the collection of names is empty, then the boolean value should be set

and it indicates whether the lack of names is valid (true),

or represents incomplete processing (false).

Only these place categories (Parking Lot, Outdoor Service, parking category/house, Place of Worship,

Public Restroom and Taxi Stand) could have attribute "is valid unnamed" as true.
operatingTimes TimeConstraint list Operating Time determines the availability of the facility type.
open24hrs boolean optional 24 Hour Indicator indicates if a Petrol Station POI is open 24hrs a day.

It is only applicable to Petrol Station POIs.
fuelType Fuel optional Type of Fuel applicable for a Petrol/Gasoline Station.
chains integer list Set of chains to which this place belongs.

Multiple chains apply when the place is belonging to multiple brands.
food string list Food Type identifies the type of food primarily offered at a restraunt.

Only one Food Type is included for a Restaurant POI.
postalCode string optional PostalCode is part of the actual address of a POI.
contacts ContactItem set Contact Info provides the contact information relative to a POI.
displayClass integer optional Place DisplayClass have values in (1,2,3,4,5,6,7,8,9), 9 is a China special value
vanityCity boolean optional Deprecated. Is the Place in vanityCity. Optional vanity-city-id is sufficient.
vanityCityId MomFeature optional Place vicinityId ,using Refernce to refer admin code in admin layer
nationalImportance boolean optional Place nationalImportance , to mark whether it's important POI
privateAccess boolean optional Place PrivateAccess ,whether it is private or not
entranceType EntranceType optional Place entranceType using Enums type EntranceType to identify whether it is Preferred Entrance
placeAssociation PlaceAssociation list Place Assocaition to build the place graph , there are three type assocation : physical ,logic, and Identity
subcategory integer optional Deprecated. Place subcategory.

The subcategory is deprecated as it is covered by the fine-grained places categories.

The element will be removed in Q1-2022.

Alternate element: `place-properties.pois.subcategories`.

For older readers of new data: This element will be populated by one of the subcategories, if applicable.

For newer readers of old data: The new alternate element will be empty.
airportType AirportType optional Place need data ingestion of place arribute -aiport type , modifier .
isOutdoor boolean optional Place isOutdoor YES/NO .
outdoorActivity OutdoorActivity optional Place outdoor activity .
restAreaType RestAreaType optional Place rest Area Type .
waterSource WaterSource optional Place water Source .
campSiteType CampSiteType optional Place camp site type .
attachmentFiles Media set Optional external attachment files, such as specific place icons with low, medium and high resolution
@ns:com:here:mom:pds Pds optional
inVicinity boolean optional Is this place just in the vicinity of its routing location (true), or does

the routing location provide direct access (false).

If undefined, the default is false.
supplierCategories SupplierCategory set Supplier categories.

Typically these are supplier or other third party driven.

While there is some logical/contextual relationship to the places native categories, they are to be considered as is.
paymentMethods PaymentType set Payment methods accepted by the place.
feedbacks Feedback set User feedbacks for the place.
feedbackSummaries FeedbackSummary set Summaries of the feedbacks for the place.

May have multiple summaries from multiple suppliers.
supplierReferences SupplierReference set Supplier provided reference data.

Example: Supplier provided id.
Constraint Expression Description
wheelchairAccessMin1 (non-empty(.wheelchairAccess) -> (head(.wheelchairAccess) >= 1))
wheelchairAccessMax3 (non-empty(.wheelchairAccess) -> (head(.wheelchairAccess) <= 3))
qualityLevelMin0 (non-empty(.qualityLevel) -> (head(.qualityLevel) >= 0))
qualityLevelMax5 (non-empty(.qualityLevel) -> (head(.qualityLevel) <= 5))
displayClassMin1 (non-empty(.displayClass) -> (head(.displayClass) >= 1))
displayClassMax9 (non-empty(.displayClass) -> (head(.displayClass) <= 9))

Poi

part Poi

Module place

Category specific properties, or properties grouped under a single category.

Since HERE Core POIs are single category, this type also holds properties required for publishing Core POIs.

Property Type Modifier Description
categoryReferences string set Categories associated with this POI.
externalReference MomFeature optional An optional reference to a HERE Core POI.
names Name list POI Name is the name by which the POI is known.
operatingTimes TimeConstraint list Operating Time determines the availability of the facility type.
open24hrs boolean optional 24 Hour Indicator indicates if a Petrol Station POI is open 24hrs a day.

It is only applicable to Petrol Station POIs.
fuelType Fuel optional Type of Fuel applicable for a Petrol/Gasoline Station
chains integer list Set of chains to which this POI belongs.

Multiple chains apply when the POI is belonging to multiple brands.
food string list Primary and alternate food types of a Core Restaurant POI.

The first element is the the primary food type. The second element, if defined, is the alternate food type.

If the POI is a restaurant this list is non-empty.
contacts ContactItem set Contact Info provides the contact information relative to a POI.
publicationData PublicationExtension optional POI published id (i.e. PVID)
buildingSubType BuildingSubType optional Building sub-type used for representing classic HERE Core POIs (as opposed to general full-fledged multi-category places).

For HERE Core POIs, the fine grained PDS Place category maps to a more general POI category

and, where needed, the more specific building-sub-type is encoded in this property.
restaurantType RestaurantType optional Restaurant type.

For HERE Core POI restaurants, the fine grained PDS Place category maps to the general POI category "restaurant"

and the specific restaurant-type is encoded in this property.
regionalFoodType string optional Regional Food Type for HERE Core POI derived from PDS place.properties.food.
supplierReferences SupplierReference set Supplier provided reference data.

Example: Supplier provided id.
subcategories integer set Subcategories associated with the POI.
Constraint Expression Description
foodMaxSize2 (size(.food) <= 2)

PoiPlaceCommon (Deprecated)

abstract part PoiPlaceCommon (Deprecated)

Module place

DEPRECATED: This type is unused.

Property Type Modifier Description
names Name list POI Name is the name by which the POI is known.
operatingTimes TimeConstraint list Operating Time determines the availability of the facility type.
open24hrs boolean optional 24 Hour Indicator indicates if a Petrol Station POI is open 24hrs a day.

It is only applicable to Petrol Station POIs.
fuelType Fuel optional Type of Fuel applicable for a Petrol/Gasoline Station
chains integer list Set of chains to which this POI/place belongs.

Multiple chains apply when the POI/place is belonging to multiple brands.
food string list Food Type identifies the type of food primarily offered at a restraunt.

Only one Food Type is included for a Restaurant POI.
contacts ContactItem set

Rating

part Rating

Module place

User rating.

Property Type Modifier Description
timeStamp IsoTimestamp optional Time stamp of the rating.
type RatingType Type of the rating.
value double Value of the rating.

Example: 4.5
scale RatingScale Scale of the rating.
Constraint Expression Description
valueWithinRatingScale ((.value >= .scale.minimum) && (.value <= .scale.maximum))

RatingScale

part RatingScale

Module place

Property Type Modifier Description
minimum double
unit double
maximum double
Constraint Expression Description
minimumMin0 (.minimum >= 0)
unitXmin0 (.unit > 0)
unitSmallEnough (.unit <= (.maximum - .minimum))
minLtMax (.minimum < .maximum)

RatingSummary

part RatingSummary

Module place

Rating Summary.

Property Type Modifier Description
count integer optional Rating count.
average double Rating average.
scale RatingScale Rating scale.
Constraint Expression Description
countMin1 (non-empty(.count) -> (head(.count) >= 1))
averageWithinRatingScale ((.average >= .scale.minimum) && (.average <= .scale.maximum))

RatingType

enum RatingType

Module place

Value Description
UNDEFINED
OVERALL The overall rating for the place.
MAIN_BUSINESS The rating that describes and grades the primary business.
FACILITIES The rating that describes and grades facilities associated with the place. Examples: Restrooms, Parking, Accessibility etc.
SERVICE The rating that describes and grades the quality of the service.
DESCRIPTION The rating that describes and grades how well and accurate the place is described/represented.
LOCATION_RATING The rating that describes and grades the location of the place. Examples: Road access,Parking availability, Safety etc.
ATMOSPHERE The rating that describes and grades the places atmosphere or surrounding environment.
COST The rating that describes and grades the costs or expenses of the place.
CUSTOMER_SERVICE The rating that describes and grades the customer service at a place.
QUALITY The rating that describes and grades the general quality of a place.
APPEAL The rating that describes and grades the appeal or customer interest of a place.
DECOR The rating that describes and grades the overall decor or design/furnishings of a place.
FOOD The rating that describes and grades the quality of food.
DINING The rating that describes and grades the dining experience Examples: Presentation, Menu choices, Courtesy etc.
ROOMS The rating that describes and grades the rooms quality, cleanness. Applicable for accommodation and hospitality facilities only.
STAR Star rating for the place.

Relation

part Relation

Module place

Relation describes whether more than one POI are sharing a location or facility. Parent/Child POIs identify a relationship between two or more POIs.

Property Type Modifier Description
relationType RelationType optional Parent/Child Relationship is applied as Physical or Logical.

Physical: When the Parent/Child POIs are physically located at the same location or directly attached to

each other.

Logical: When the Parent/Child POIs are not physically located at the same location or directly attached to

each other.

RelationType

enum RelationType

Module place

Value Description
COLOCATED

RestAreaType

enum RestAreaType

Module place

Value Description
UNDEFINED
COMPLETE_REST_AREA
PARKING_AND_REST_ROOM_ONLY
PARKING_ONLY
MOTORWAY_SERVICE_AREA
SCENIC_OVERLOOK

RestaurantType

enum RestaurantType

Module place

Restaurant Type enumerations are listed RSTRNTTP Domain.

Value Description
UNDEFINED
FAST_FOOD
CASUAL_DINING
FINE_DINING
TAKE_OUT_AND_DELIVERY_ONLY
FOOD_MARKET_STALL
TAQUERIA
DELI
CAFETERIA
BISTRO

Review

part Review

Module place

User review.

Property Type Modifier Description
timeStamp IsoTimestamp optional Time stamp of the review.
id string optional Id of the review, provided by the review supplier.
text Text optional Review message.
ratings Rating set Ratings associated with this review. If there

are multiple ratings they have different rating types.
Constraint Expression Description
distinctRatingTypes (size(.ratings) == size(to-set(.ratings.type)))

ReviewSummary

part ReviewSummary

Module place

Review Summary.

Property Type Modifier Description
count integer Review count.
Constraint Expression Description
countMin1 (.count >= 1)

Status

enum Status

Module place

Value Description
UNDEFINED
ACTIVE
INACTIVE
SEASONAL
OUT_OF_BUSINESS
TEMPORARILY_OUT_OF_BUSINESS
OPENING_SOON
GOING_OUT_OF_BUSINESS
OTHER
UNKNOWN

SupplierCategory

part SupplierCategory

Module place

Supplier provided category.

Property Type Modifier Description
supplierId string The id of the category supplier.
system string The category system to which this category belongs, as free text.

Can be a supplier specific category system or an industry standard category system.

Examples of industry standard category systems are NAICS and NACE.
id string Id of the category. It must be unique within the specified combination of system and supplier-id.
description Text optional Category Description.

SupplierReference

part SupplierReference

Module place

Supplier provided reference data.

Property Type Modifier Description
supplierId string The id of the supplier providing the reference data.
system string optional The reference system identifier on supplier side as free text.

Examples: Verification system, Meta Data system
type string optional The type of reference provided by supplier as free text.

Examples: SUPPLIER_POIID, SOURCE_IDENTIFIER
value string The reference value as free text.

WaterSource

enum WaterSource

Module place

Value Description
UNDEFINED
WELL
MUNICIPAL
SURFACE_WATER

results matching ""

    No results matching ""