Points of interest (POI) API

Overview

• Customers can create/update/delete/get/query the customer-specific POI information via the POI API.
• The POI API is served as a REST interface.

API specification

• Detailed REST interfaces are defined in the Context Mapping REST API.

Basic capabilities

• Create/Update/Delete/Get/Query.
  • Multiple records manipulations is supported.
• Query.
  • Geohash based query.
    • Longitude/Latitude query.
    • Geohash scale level for query API.
      • Geohash level is always fixed as scale level 7.
        • https://en.wikipedia.org/wiki/Geohash
      • For a query with polygon geometry, if the scale level is larger than 4, the query scale level is always reduced to 4 from a performance perspective.
      • Therefore, the current POI API supports only scale level 4 for a polygon geometry query.
      • Point and LineString geometry support scale level 7.
  • Value filter.
  • Circle support, the radius from center Longitude/Latitude.

Additional information

navigation_points for route search

• Assumptions.
  • The POI's entrance and exit can be different from center of POI.
  • Multiple entrances and exits can exist on each POI.
• If navigation_points is defined under properties of GeoJSON, the Dynamic Map Manager (DMM) uses the information when the routing service is called.

  Supported functionalities on navigation_points for route search from IBM IoT Connected Vehicle Insights V3.1

• The value of navigation_points is array structure.
• Only the first navigation_point is used on DMM.
• Can not distinguish entrance/exit.
• Can not use multiple entrance/exit.
• coodinates and heading fields are considered on DMM routing service but unknown fields are ignored.

{
    "type": "Feature",
    "id": "poi-xxx-yyy-zzz",
    "properties": {
        "building_name": "IBM Hakozaki",
        "phone_number": "090-1234-56789-000025",
        "navigation_points": [
            {
                "coordinates": [
                    139.786601,
                    35.679782
                ],
                "heading": 180
            }
        ]
    },
    "geometry": {
        "type": "Point",
        "coordinates": [
            35.678581,
            139.787306
        ]
    }
}

Detailed specification for Query including POST body detail

• If GeoJSON is the format to represent Feature objects and the feature object has a properties field, then the name-value pairs in the properties field are used for value-filtering.
• Supported GeoJSON.
  • Geometry level.
    • Geometry only - Point
  • Feature level - if properties name-value pairs are specified, the pairs are used for value filtering
    • Feature with Geometry - Point

Query parameter detail

POST body detail

• Query is supported as GeoJSON format.
  • Point
  • LineString
  • Polygon (Single and Exterior only)
• If GeoJSON is the format to represent Feature objects and the feature object has a properties field, then the name-value pairs in the properties will be used for value-filtering as AND condition.
• Supported GeoJSON
  • Geometry level
    • Geometry only - Point
    • Geometry only - LineString
    • Geometry only - Polygon (Single and exterior only)
  • Feature level - if properties name-value pairs are specified, they are used for value filtering
    • Feature with Geometry - Point
    • Feature with Geometry - LineString
    • Feature with Geometry - Polygon (Single and exterior only)

Query specification

Point	Point with circle

LineString	Polygon