HERE probe JSON

The HERE probe JSON data format is a text-based JSON format.

Such probes can have one or multiple probe points.

Probe format

The format is as follows:

{
  "provider": "some-provider",
  "pp": [ point1, point2, ..., point_N ]
}

Field	Mandatory	Type	Validation	Description
provider	yes	String	non-null	The name of the provider or vendor that collected the probe data.
pp	yes	array of points	non-null	The list of probe points.
pe	no	array of events	non-null	The list of events.

Probe point format

This is an example of a probe with two probe points and an event:

{
  "provider": "DEFAULT",
  "pp": [
    {
      "id": "trace_12345",
      "h": "24",
      "s": "48",
      "x": 13.484339,
      "y": 52.506489,
      "t": "2018-05-07T02:37:50",
      "a": null,
      "ad": {}
    },
    {
      "id": "trace_12345",
      "h": "25",
      "s": "NA",
      "x": 13.482277,
      "y": 52.506351,
      "t": "2018-05-07T02:38",
      "a": 100,
      "ad": {}
    }
  ],
  "pe": [
    {
      "id": "trace_12345",
      "t": "2018-05-07T02:37:50",
      "x": 13.484339,
      "y": 52.506489,
      "a": 100,
      "tp": "testEventType",
      "tp2": "testEventSubtype",
      "ad": {
        "attr1": "value1",
        "attr2": "123"
      }
    }
  ]
}

The probe points contain the following fields:

Field	Mandatory	Type	Validation	Description
id	yes	String	non-null	The preferably unique ID of the device collecting the probe data.
h	yes	String	0 .. 359	The compass heading of the GPS reading in integer values clockwise from 0 to 359 degrees where 0 is due North.
s	yes	String	non-negative	The speed recorded from the GPS reading. All speeds are in KPH. If not a number, a numeric error code will be assigned. Error codes are negative numbers, for example -10.
x	yes	Double	-180.0 .. +180.0	The longitude of the GPS reading in decimal degrees with a minimum of 5 decimal point precision.
y	yes	Double	-90.0 .. +90.0	The latitude of the GPS reading in decimal degrees with a minimum of 5 decimal point precision.
t	yes	String	non-null	The timestamp in this format: yyyy-mm-ddThh:mm:ss in UTC. Time must be in 24-hour notation.
a	no	Integer	-	The altitude of the GPS reading in integer values representing the meters below/above sea level.
hp	no	Integer	non-negative	The horizontal dilution of precision (HDOP) as derived from the location of the satellites used in the GPS.
sa	no	Integer	non-negative	The number of satellites used in the GPS reading.
er	no	Integer	non-negative	The error radius of the GPS reading in expressed in meters with no decimal values.
mx	no	Double	-180.0 .. +180.0	The longitude result of the vendor’s map matching algorithm.
my	no	Double	-90.0 .. +90.0	The latitude result of the vendor’s map matching algorithm.
am	no	Integer	Enumeration of 1=TRACKING (general usage), 2=NAVIGATING (actively routing/navigating) and 3=PEDESTRIAN	Representation of the application's mode of operation at the time when the probe was collected.
dt	no	Integer	Enumeration of 1=COMMERCIAL TRUCK, 2=NON-COMMERCIAL AUTOMOBILE, 3=MOBILE PHONE, 5=BUS, 6=COMMERCIAL_CAR, 7=LIGHT_COMMERCIAL_CAR, 8=HEAVY_COMMERCIAL_TRUCK, 9=NAVIGATION, 10=OTHER, 11=TWO_WHEELERS, 12=EMERGENCY_VEHICLE	This parameter identifies the device or vehicle type for which the probe was collected.
ad	no	Map	JSON object	This should capture an unlimited key/value representation of any additional data that the vendor collects. The format should be a JSON object with key-value pairs. For example: "ad":{"key1":"value1","key2":"value2","key3":"value3"}.

Currently, if HERE probe JSON format is used in input with optional non-mandatory fields then those values are cut out (omitted) from the output result.

Probe events contain the following fields:

Field	Mandatory	Type	Validation	Description
id	yes	String	non-null	The preferably unique ID of the device collecting the probe data.
x	no	Double	-180.0 .. +180.0	The longitude of the GPS reading in decimal degrees with a minimum of 5 decimal point precision.
y	no	Double	-90.0 .. +90.0	The latitude of the GPS reading in decimal degrees with a minimum of 5 decimal point precision.
t	yes	String	non-null	The timestamp in this format: yyyy-mm-ddThh:mm:ss in UTC. Time must be in 24-hour notation.
a	no	Integer	-	The altitude of the GPS reading in integer values representing the meters below/above sea level.
tp	yes	String	-	A customer-specific string describing the type of the event, like "RoadWeather", "Hazard", "TrafficCondition", "Maneuver" etc.
tp2	no	String	-	A customer-specific string describing the sub-type of the event, like "SNOW" for "RoadWeather", "ACCIDENT" for "Hazard", "SLOW" for "TrafficCondition", "BREAKING" for "Maneuver" etc.
ad	no	Map	JSON object	This should capture an unlimited key/value representation of any additional data that the vendor collects. The format should be a JSON object with key-value pairs. For example: "ad":{"key1":"value1","key2":"value2","key3":"value3"}.

Currently, an event is either dropped or passed through as is.