# Trace route REST API, Service version 1.0.0 > API reference: [`POST /routing/1.0/traceroute`](https://benomad.com/dev/doc/bemap-api/api/routing/routing-traceroute.md) Performs a road-matching of GPS coordinates and routing process for a specified type of vehicle. Road-matching consists in correcting uncertainties related to GPS measurements by repositioning a vehicle on the most accurate segment of neighboring roads. This service assumes that an input position corresponds to a chronological sequence of positions of a given vehicle driving on the road network. ## Summary 1. Request 1. Mandatory parameters 2. Optional parameters 2. Response 1. Details of fields 2. Response samples ## Request The request must be sent with the HTTP method `POST` and the HTTP header `Content-Type` set to `application/json`. Sample: URI: `/bgis/service/routing/1.0/traceroute` POST data: ```javascript { "destinations" : [ { "coordinateSat" : { "lon" : 7.066, "lat" : 43.616, "heading" : 17.6, "speed" : 23.1, "time" : 1396241966000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0664, "lat" : 43.6162, "heading" : 95.0, "speed" : 29.3, "time" : 1396241972000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0786, "lat" : 43.6153, "heading" : 119.0, "speed" : 61.9, "time" : 1396242062000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0805, "lat" : 43.6147, "heading" : 200.9, "speed" : 50.6, "time" : 1396242077000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0785, "lat" : 43.6117, "heading" : 115.8, "speed" : 38.1, "time" : 1396242104000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0787, "lat" : 43.6118, "heading" : 15.6, "speed" : 26.0, "time" : 1396242107000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0793, "lat" : 43.6128, "heading" : 76.0, "speed" : 26.6, "time" : 1396242128000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0814, "lat" : 43.6116, "heading" : 269.9, "speed" : 5.6, "time" : 1396242172000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0811, "lat" : 43.6117, "heading" : 338.7, "speed" : 7.5, "time" : 1396242182000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0812, "lat" : 43.6119, "heading" : 47.3, "speed" : 14.9, "time" : 1396241966000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0815, "lat" : 43.6119, "heading" : 127.1, "speed" : 8.5, "time" : 1396242198000, "sat" : 11 } }, { "coordinateSat" : { "lon" : 7.0816, "lat" : 43.6118, "heading" : 0.0, "speed" : 0.0, "time" : 1396242288000, "sat" : 11 } } ], "routingVehicleProfile" : { "transportMode" : "CAR", "routingVehicleFeature" : { "height" : 380, "width" : 40, "length" : 1875, "weight" : 35, "axleWeight" : 10 } }, "options": ["ROUTESHEET","POLYLINE","POLYLINE_INDEX"] } ``` All coordinates are defined by longitude and latitude, see the [coordinate system](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md) glossary for more details. ### __Parameters__ - `destinations` (TraceRouteDest[], required): Defines an array of GPS coordinates and other parameters. - `coordinateSat` (CoordinateSat): GPS coordinates. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `heading` (number (double)): Heading in degrees. - `speed` (number (float)): Speed in km/h. - `time` (integer (int64)): GPS time in milliseconds (EPOCH). - `sat` (integer (int32)): Number of GPS satellites available. - `keptByMinimalWp` (boolean): This parameter `keptByMinimalWp` (previously `mandatory`) will be used by the traceroute API. When the value is set to `true` and the option `NO_MINIMAL_WAYPOINTS` is not defined, the coordinate will be kept in the waypoints array of the response. Also accepted as `mandatory`. - `customData` (CustomDt[]): Custom data is a list that can be used to set some custom information about the coordinate in input and returned in response. - `key` (string) - `value` (string) - `routingVehicleProfile` (RoutingVehicleProf, required): A routing vehicle profile defines physical, legal, toll and energetic characteristics. - `transportMode` (enum): Defines the transportation mode: Car, pedestrian, truck, etc. Default value is `CAR`, except for Traceroute service for which default value is `EMERGENCY`. The map data contains information which are related to transportation mode such as: traffic directions, turn restrictions and road accessibility. Therefore the transportation mode can affect the route calculation. - `PEDESTRIAN`: Pedestrian. - `BICYCLE`: Bicycle. - `MOTORCYCLE`: Motorcycle. - `CAR`: Passenger car. - `TAXI`: Taxi. - `PUBLIC_BUS`: Public bus. - `EMERGENCY`: Emergency vehicle. - `DELIVERY_TRUCK`: Delivery truck. Deprecated, use `TRUCK` instead. - `TRUCK`: Truck. - `maxSpeeds` (RoutingMaxSpd[]): Defines a maximum speed in km/h for the vehicle. It is possible to discriminate two different maximum speeds: one to be used for route calculation (`CAL`) and another one for route time estimation (`ETA`). By default (`ALL`) the speed applies to both cases. - `maxSpeed` (integer (int32)): Specifies a maximum speed for a vehicle in km/h. - `type` (enum): Defines if max speed should be used for route calculation (`CAL`) and/or for route time estimation (`ETA`). By default (`ALL`) the speed applies to both cases. - `ALL`: Maximum speed apply to route calculation and to route ETA. - `CAL`: Maximum speed apply only to route calculation. - `ETA`: Maximum speed apply only to route ETA. - `routingVehicleFeature` (RoutingVehicleFtr): Defines the routing vehicle feature. A routing vehicle feature defines physical, legal and toll characteristics. - `height` (integer (int32)): Height of vehicle in centimeters. Affects route calculation. Physical restriction. - `width` (integer (int32)): Width of vehicle in centimeters. Affects route calculation. Physical restriction. - `length` (integer (int32)): Length of vehicle in centimeters. Affects route calculation. Physical restriction. - `weight` (integer (int32)): Weight of vehicle in tens of metric tons, i.e.: `35` = 3.5t. Affects route calculation. Legal and physical restrictions. - `axleWeight` (integer (int32)): Axle weight in tens of metric tons, i.e.: `12` = 1.2t. Affects route calculation. Legal and physical restrictions. - `hazardousMaterials` (enum): Hazardous materials carried by the vehicle. Affects route calculation. Legal restriction. - `NONE`: No hazardous material. - `ALL`: General hazardous materials. - `EXPLOSIVE`: Trucks with Explosive and Flammable Goods. - `WATER`: Trucks with Goods Harmful for Water. - `US_CORROSIVE`: USA only : Corrosive materials (e.g., hydrochloric acid, sulfuric acid, mercury, sodium hydroxide). - `US_EXPLOSIVES`: USA only : Explosives (e.g., TNT, ammunition, flares, fireworks). - `US_FLAM`: USA only : Flammable and combustible liquids (e.g., jet fuel, gasoline, fuel oil, alcohols). - `US_FLAM_SOL`: USA only : Flammable solids, spontaneously combustible materials and water reactive substances (e.g., matches, white phosphorus, potassium). - `US_GAS`: USA only : Flammable, compressed and poisonous gases (e.g., propane, compressed oxygen, chlorine). - `US_ORGANIC`: USA only : Oxidizers and organic peroxides (e.g., ammonium nitrate and benzoyl peroxide). - `US_OTHER`: USA only : Miscellaneous hazardous materials (e.g., asbestos, dry ice, lithium batteries). - `US_PIH`: USA only : Poisonous inhalation hazards (PIH). - `US_POISON`: USA only : Poisonous (toxic) and infectious substances (e.g., cyanide, most mercury-based compounds, viruses, toxins and regulated medical waste). - `US_RADIO_ACTIVE`: USA only : Radioactive materials (e.g., plutonium-239 and uranium-235). - `TUNNEL_CAT_B`: Tunnel Category B. - `TUNNEL_CAT_B1000C`: Tunnel Category B1000C. - `TUNNEL_CAT_BD`: Tunnel Category B/D. - `TUNNEL_CAT_BE`: Tunnel Category B/E. - `TUNNEL_CAT_C`: Tunnel Category C. - `TUNNEL_CAT_C5000D`: Tunnel Category C5000D. - `TUNNEL_CAT_CD`: Tunnel Category C/D. - `TUNNEL_CAT_CE`: Tunnel Category C/E. - `TUNNEL_CAT_D`: Tunnel Category D. - `TUNNEL_CAT_DE`: Tunnel Category D/E. - `TUNNEL_CAT_E`: Tunnel Category E. - `nbTrailer` (integer (int32)): Vehicle's number of trailers (`-1`: not defined, `0`: no trailer). Affects route calculation. Legal restriction. - `tollTransportCategory` (enum): Defines the toll vehicle category. Affects toll calculation. `UNDEFINED` by default. - `UNDEFINED`: Undefined. - `MOTORCYCLE`: Motorcycle. - `AUTO`: Automobile. - `TRUCK`: Truck. - `MOTOR_HOME`: Motor home. - `MINIBUS`: Mini bus. - `BUS`: Bus. - `SIDECAR`: Sidecar (EU only). - `TRICYCLE`: Tricycle (EU only). - `DLV_TRUCK`: Delivery truck (EU only). - `SNOWMOBILE`: Snowmobile (US only). - `PICK_UP`: Pick up (US only). - `TRACTOR`: Tractor (US only). - `caravan` (enum): Defines if the vehicle has a caravan. Affects toll calculation. `UNDEFINED` by default. - `UNDEFINED`: Undefined. - `YES`: Yes. - `NO`: No. - `hybrid` (enum): Defines if vehicle has a hybrid engine. Affects toll calculation. `UNDEFINED` by default. - `UNDEFINED`: Undefined. - `YES`: Yes. - `NO`: No. - `disEquipped` (enum): Defines if vehicle is equipped for disabled people. Affects toll calculation. `UNDEFINED` by default. - `UNDEFINED`: Undefined. - `YES`: Yes. - `NO`: No. - `pollMin` (enum): Defines if vehicle has minimal pollution. Affects toll calculation. `UNDEFINED` by default. - `UNDEFINED`: Undefined. - `YES`: Yes. - `NO`: No. - `hov` (enum): Defines if vehicle is a High Occupancy Vehicle (USA only). See [Wikipedia: High-occupancy vehicle lane](http://en.wikipedia.org/wiki/High-occupancy_vehicle_lane). Affects toll calculation. `UNDEFINED` by default. - `UNDEFINED`: Undefined. - `YES`: Yes. - `NO`: No. - `cial` (enum): Defines if vehicle is a commercial vehicle. Affects toll calculation. `UNDEFINED` by default. - `UNDEFINED`: Undefined. - `YES`: Yes. - `NO`: No. - `nbVehAxles` (integer (int32)): Defines the number of axles of the vehicle (optional). Affects toll calculation. - `nbTrailAxles` (integer (int32)): Defines the number of axles of the trailer (optional). Affects toll calculation. - `nbTires` (integer (int32)): Defines the number of tires (optional). Affects toll calculation. - `nbPassengers` (integer (int32)): Defines the number of passengers (optional). Affects toll calculation. - `vehHeight` (integer (int32)): Defines vehicle's height in centimeters (optional, use field `height` to define total height : vehicle + trailer). Affects toll calculation. - `trailHeight` (integer (int32)): Defines trailer's height in centimeters (optional, use field `height` to define total height : vehicle + trailer). Affects toll calculation. - `vehWeight` (integer (int32)): Defines vehicle's weight in tens of tons (optional, use field `weight` to define total weight : vehicle + trailer). Affects toll calculation. - `emissionClass` (enum): Defines vehicle's emission type (optional). See [Wikipedia: European emission standards](http://en.wikipedia.org/wiki/European_emission_standards). Affects toll calculation. - `UNDEFINED`: Undefined. - `EURO1`: EURO I. - `EURO2`: EURO II. - `EURO3`: EURO III. - `EURO4`: EURO IV. - `EURO5`: EURO V. - `EURO6`: EURO VI. - `EURO_EEV`: EURO EEV. - `ELECTRIC`: EURO Electric. - `EURO0`: EURO 0 - `EURO2_PRC`: EURO II with PRC (Particle Reduction Composite/System) - `EURO3_PRC`: EURO III with PRC (Particle Reduction Composite/System) - `EURO6_CO2_1`: EURO VI CO2 1 - `EURO6_CO2_2`: EURO VI CO2 2 - `EURO6_CO2_3`: EURO VI CO2 3 - `EURO6_CO2_4`: EURO VI CO2 4 - `EURO6_CO2_5`: EURO VI CO2 5 - `MAX`: Maximal value. - `adrTunnelCategory` (enum): ADR tunnel category defines all supported ADR (EU only, European Agreement concerning the International Carriage of Dangerous Goods by Road). Affects route calculation. - `NONE`: No tunnel category restriction (category A). - `CAT_B`: Tunnel Category B. - `CAT_C`: Tunnel Category C. - `CAT_D`: Tunnel Category D. - `CAT_E`: Tunnel Category E. - `onlyPhysical` (boolean): Defines if vehicle's weight (weight, weight per axle and trailers) and hazardous materials (hazardous materials and ADR) should be ignored outside respectively bridges and tunnels. `false` by default. Affects route calculation. - `routingEnergyVehicleFeature` (RoutingEnergyVehicleFtr): Energy vehicle feature for energy consumption estimation. - `scx` (number (double)): Product of vehicle's front area and aerodynamic coefficient (in m²). - `crr` (number (double)): Vehicle's tire rolling resistance coefficient (dimension-less, in interval ]0, 1[). - `engineEfficiency` (number (double)): Vehicle's efficiency coefficient between engine and gear (dimension-less, in interval ]0, 1[). - `batCapacity` (number (double)): Vehicle's capacity of the battery (in kWh, only if electric vehicle or hybrid re-chargeable, 0 otherwise). - `energyLoad` (number (double)): Vehicle's current energy load, state of charge (in kWh). - `dryWeight` (integer (int32)): Vehicle's weight without any consumables or passengers (in kg). - `payload` (integer (int32)): Vehicle's extra load (consumables or passengers weight for example) (in kg). - `auxConsumption` (integer (int32)): Vehicle's instantaneous auxiliary equipments consumption (in W). - `maxAccel` (number (double)): Maximum acceleration (superior to 0.1, in m/s², based on vehicle's acceleration capacity and expected driving behavior). - `maxDecel` (number (double)): Maximum deceleration (inferior to -0.1, in m/s², based on vehicle's braking capacity and expected driving behavior). - `extTemp` (number (float)): Outside temperature (in °C). - `maxChargePower` (number (double)): Maximum charge power AC single phase authorized by the vehicle (in kW). - `maxChargePowerAc3` (number (double)): Maximum charge power AC three phases authorized by the vehicle (in kW). - `maxChargePowerDc` (number (double)): Maximum charge power DC authorized by the vehicle (in kW). - `regenerativeBraking` (boolean): Defines if the vehicle supports regenerative braking (default = true). - `routingEnergyVehicleConnectorTypeIds` (integer (int32)[], deprecated): Connector (plug) type of electrical vehicle, used for energy consumption estimation. Deprecated Use the API Charging Station. - `routingEnergyVehicleRanges` (integer (int64)[], deprecated): Energy vehicle range. Define the pre-calculated electric vehicle autonomy in meters. - `chargingStationProviderName` (string, deprecated): Name of charging station provider used to research the chargning station pools. Deprecated Use the API Charging Station. - `routingSpeedPonderations` (RoutingSpeedPond[]): Defines a speed coefficient for the specified road element's classification. Note: This parameter has no effect on the Traceroute service. - `factor` (number (float), required): Specifies the speed coefficient. A value under 1 to reduce the speed, e.g: 0.8. A value over 1 to increase the speed, e.g: 1.3. `1` by default. - `level` (integer (int32), required): Road element's level (0: all 4 levels, 1: main level, 2: secondary level, 3: third level, 4: fourth level). - `roadType` (enum): Define the road type. - `ALL`: All road network. - `DEFAULT`: Default. - `FERRY`: Ferry line. - `MOTORWAY`: Motorway. - `PEDESTRIAN`: Pedestrian. - `ROUNDABOUNT`: Roundabout. - `SLIPROAD`: Slip road. - `pondType` (enum): Define the ponderation type. - `ALL`: Speed coefficient applies both for finding the fastest route and calculating its ETA. Default value. - `CAL`: Speed coefficient applies only searching for the fastest route (only when fastest criteria is set). - `ETA`: Speed coefficient applies only for calculating route's travel time (ETA). - `routingCrossPenaltiesCoefficients` (RoutingCrossPenaltiesCoef[]): Defines a cross-penalties coefficient for the specified road element's classification. Note: This parameter has no effect on the Traceroute service. - `factor` (number (float), required): New coefficient factor for cross-penalties (Default = 1). - `ptype` (enum): Enumeration taken into account by routing calculation. It defines if speed coefficient applies only for searching the fastest route (only when fastest criteria is set) or for calculating the route's travel time (ETA) or both. - `ALL`: Speed coefficient applies both for finding the fastest route and calculating its ETA. Default value. - `CAL`: Speed coefficient applies only searching for the fastest route (only when fastest criteria is set). - `ETA`: Speed coefficient applies only for calculating route's travel time (ETA). - `type` (enum): Defines if a new coefficient applies to route calculation or to route ETA or both (Default = ALL). - `ALL`: Speed coefficient applies both for finding the fastest route and calculating its ETA. Default value. - `CAL`: Speed coefficient applies only searching for the fastest route (only when fastest criteria is set). - `ETA`: Speed coefficient applies only for calculating route's travel time (ETA). - `geoserver` (string): Geoserver name. - `swidx` (integer (int32), deprecated): Switch index. - `options` (enum[]): Options of trace route service. - `USED_DESTINATIONS_OFF`: Disables used destinations list in the response. - `ROUTESHEET`: Returns the route sheet. - `ROUTESHEET_VERBOSE_LOW`: Low level of verbosity for the route sheet (default). - `ROUTESHEET_VERBOSE_MEDIUM`: Medium level of verbosity for the route sheet. - `ROUTESHEET_VERBOSE_HIGH`: High level of verbosity for the route sheet. - `FENCE_SHAPE`: Enables the tests between route found and geometric fences. Return the shape of fence used to perform the test. - `POLYLINE`: Returns the polyline (geometry) of the entire itinerary. For segmentation of this geometry, see the `EVENT` and `EVT_POLYINE` options. - `DETAILED_POLYLINE`: Returns the polyline (geometry) of itinerary with more information for each sub-segments. Deprecated, use events system (like `EVENT`, `EVT_POLYLINE`) instead. - `POLYLINE_INDEX`: Enables the index calculation of used destination on the polyline. Deprecated, use events system (like `EVENT`, `EVT_POLYLINE`) instead. - `OPENLR`: Attempt to return the geometry of route as an encoded OpenLR base64 string. Some routes cannot be encoded in OpenLR (like U-turns). - `SEGMENTIDS`: Returns the list of segments id of itinerary. - `ROAD_SEGMENTS`: Returns the list of road segments of itinerary. See in response the field `roadSegments`. - `JUNCTION_NODES`: Returns the junction nodes of itinerary. See in response the field `junctionNodes`. - `WAYPOINTS`: Returns the waypoints of itinerary. A waypoint is a coordinate with properties that can be used to reproduce the computed route on other device or server. - `NO_MINIMAL_WAYPOINTS`: Sub option of `WAYPOINTS` option. Disables the minimal waypoints algorithm. By default the waypoint list contains only the waypoints necessary to reproduce the route. With this option all waypoints are returned (faster computation). - `OFFROADS`: Sub option of `WAYPOINTS` option. Returns the off-road polylines in the `waypoints` array of the response. See the field `waypoints.offRoad` in response. - `OFFROADS_RAWDATA`: Sub option of `OFFROADS` option. Returns the native value of map attributes of the Off-road section. - `WAYPOINTS_POLYLINE`: Returns the polyline of the route including the waypoints coordinate. - `ENERGY_CONSUMPTION`: Returns the energy consumption estimation (`energyConsumption` field). This option requires the Energy vehicle feature, see field `routingVehicleProfile` and sub field `routingEnergyVehicleFeature`. - `TOLL_COST`: Enables the toll cost calculation. This option requires the Vehicle Profile, see field `routingVehicleProfile` and sub field `routingVehicleFeature`. Contact the support for the required map data. Deprecated replaced by EVT_TOLL_COST option. - `TAX_COST`: Enables the tax cost calculation. This option requires the Vehicle Profile, see field `routingVehicleProfile` and sub field `routingVehicleFeature`. Contact the support for the required map data. Deprecated replaced by EVT_TAX_COST option. - `ECO_TAX`: Enables the eco-tax calculation. This option requires the Vehicle Profile, see field `routingVehicleProfile` and sub field `routingVehicleFeature`. Contact the support for the required map data. Deprecated replaced by EVT_TAX_COST option. - `REVGEO_POSTAL_ADDRESS`: Returns the postal addresses of matched input coordinates. - `EVENT`: Enables structure of events on road. See sub options `EVT_xxxxx` other values. At a minimum the information returned is the country code of every road segment. Each event indicates the distance, travel time and percentage from start. - `EVT_DUPLICATE_FILTER`: Sub option of `EVENT` option. Enables filter on repeated values. Avoids repeating events on every road segments when there are no changes. - `EVT_ENTRY_VALUE_AS_OBJECT`: Sub option of `EVENT` option. Enables generation of entrie's values as a JSON object instead of encapsulating in a string format. - `EVT_ROAD_FEATURE`: Sub option of `EVENT` option. Enables the road features such as: maximum speed, bridge, tunnel, number of lanes in each direction, etc. - `EVT_PROHIBITED_DRIVING`: Sub option of `EVENT` option. Enables the prohibited driving information like against traffic direction (`againstTrafficDir`), prohibited turn (`prohibitedTurn`) and prohibited blocked passage (`prohibitedBlockedPassage`). - `EVT_ELEVATION`: Sub option of `EVENT` option. Enables the elevation of road segments. Returns the altitude of first point and last point in two entries. Deprecated, use `EVT_ELEVATION2` instead. - `EVT_ELEVATION2`: Sub option of `EVENT` option. Enables the elevation of road segments. Returns the altitude of first point and last point in one entry. - `EVT_SEGMENT_INFO`: Sub option of `EVENT` option. Enables the road segments information. Returns the ID of road segment (if available in the map data) and the reverse direction flag that indicates if the road segment is traveled in the opposite direction of the geometry of the road in map data. - `EVT_GEOELEMENT_TYPE`: Sub option of `EVENT` option. Enables the road segment type: The administrative levels (`roadAdminLevel` parameter): `FOURTH_ROAD`, `TERTIARY_ROAD`, `SECONDARY_ROAD`, `MAIN_ROAD`. And the `geoElementType` parameter: `PEDESTRIAN`, `ROUNDABOUT`, `SLIP_ROAD`, `ROAD`, `MOTORWAY`, `FERRY` - `EVT_POLYLINE`: Sub option of `EVENT` option. Enables the polyline geometry. - `EVT_ENCODED_POLYLINE`: Sub option of `EVENT` option. Enables the [encoded polyline geometry](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-google-encoded-polyline-algorithm-format.md). - `EVT_LENGTH`: Sub option of `EVENT` option. Enables length in meters of road segment. - `EVT_DURATION`: Sub option of `EVENT` option. Enables estimated travel duration in seconds of road segment. - `EVT_ENERGY_CONSUMPTION`: Sub option of `EVENT` option. Enables the autonomy limit event estimation. Additionally this option requires the Energy vehicle feature (`routingEnergyVehicleFeature`) parameter. The returned `energyEndOfAutonomyAt` field indicates the distance in meters from start. The returned `energyEndOfAutonomyCoord` field indicates the location of the autonomy limit. - `EVT_ENERGY_CONSUMPTION_SAMPLE`: Sub option of `EVENT` option. Enables the energy consumption estimation with samples data in events structure. Additionally this option requires the Energy vehicle feature (`routingEnergyVehicleFeature`) parameter. The returned energy sample (`EnergySample`) contains the following fields for each second: `distFromStart` in meters, `speed` in m/s, `acceleration` in m/s², `angle` in degrees, `slope` (coefficient), `cumulativeConsumption` in Wh, `pos` coordinate ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)) and altitude in meters of event. - `EVT_CHARGING_STATION`: Sub option of `EVENT` option. Add electrical charging station information (static data). Deprecated Use the API Charging Station. - `EVT_CHARGING_STATION_DYNAMIC`: Sub option of `EVENT` option. Add electrical charging station information (dynamic data). Deprecated Use the API Charging Station. - `EVT_TOLL_COST`: Sub option of `EVENT` option. Enables the toll cost calculation. This option requires the Vehicle Profile, see field `routingVehicleProfile` and sub field `routingVehicleFeature`. Contact the support for the required map data. See the response structure `RoutingTollCst` and `Tol` of entry type `TollCost`. Contact the support for the required map data. - `EVT_TAX_COST`: Sub option of `EVENT` option. Enables the tax cost calculation. This option requires the Vehicle Profile, see field `routingVehicleProfile` and sub field `routingVehicleFeature`. Contact the support for the required map data. See the response structure `RoutingTaxCst` and `RoutingTaxSect` of entry type `TaxCost`. Contact the support for the required map data. - `EVT_TRAFFIC`: Sub option of `EVENT` option. Returns the real time traffic info in event structure of type `TrafficElement`. The information contains the `jamFactor` in percentage, `reason` (text), `currentAvrSpeed` in km/h, `freeFlowAvrSpeed` in km/h, etc. NOTE: This option does not affect the route calculation, use the option `TRAFFIC` for that. - `EVT_TRAFFIC_PREDICTIVE`: Sub option of `EVENT` option. Returns the real time predictive traffic info in event structure of type `TrafficElement`. The information contains the `jamFactor` in percentage, `reason` (text), `currentAvrSpeed` in km/h, `freeFlowAvrSpeed` in km/h, etc. NOTE: This option does not affect the route calculation. The route calculation is never affect by predictive traffic. Contact the support for the required map data. - `EVT_TRAFFIC_HISTORICAL`: (Beta) Sub option of `EVENT` option. Returns the historical traffic info (i.e. the real time in the past) in event structure of type `TrafficElement`. Requires a `departureTime` in the past. The information contains the `jamFactor` in percentage, `reason` (text), `currentAvrSpeed` in km/h, `freeFlowAvrSpeed` in km/h, etc. NOTE: This option does not affect the route calculation. The route calculation is never affect by predictive traffic. Contact the support for the required map data. - `EVT_ROUTESHEET`: Sub option of `EVENT` option. Enables the route-sheet turn-by-turn instructions in event structure with type `Routesheet`. See the class `RoutingInstruc`. - `EVT_TRAFFIC_SIGNS`: Sub option of `EVENT` option. Enables the traffic sign information in event structure with type `TrafficSign`. `text` (optional) text displayed below traffic sign, `matchedCoordinate` location of traffic sign, `category`, see available values: `NOT_SUPPORTED`, `ROAD_NARROWS`, `SHARP_CURVE_LEFT`, `SHARP_CURVE_RIGHT`, `WINDING_RD_LEFT`, `WINDING_RD_RIGHT`, `STEEP_HILL_UP`, `STEEP_HILL_DOWN`, `LATERAL_WIND`, `GENERAL_WARNING`, `RISK_OF_GROUNDING`, `GENERAL_CURVE`, `GENERAL_HILL`, `OBJECT_OVERHANG`, `ST_NO_OVERTAKING`, `END_NO_OVERTAKING`, `PR_OVERTAKING_EL`, `PR_OVERTAKING_ELR`, `PR_OVERTAKING_ELL`, `LANE_MERGE_RIGHT`, `LANE_MERGE_LEFT`, `LANE_MERGE_CENTER`, `RAILWAY_CROSS_PR`, `RAILWAY_CROSS_UNPR`, `ST_NO_OVERTAKING_TRUCKS`, `END_NO_OVERTAKING_TRUCKS`, `STOP`, `END_OF_ALL_RESTRICTIONS`, `ANIMAL_CROSSING`, `ICY_CONDITIONS`, `SLIPPERY_ROAD`, `FALLING_ROCKS`, `SCHOOL_ZONE`, `TRAMWAY_CROSSING`, `CONGESTION_HAZARD`, `ACCIDENT_HAZARD`, `PRIORITY_ONCOMING`, `YIELD_ONCOMING`, `RIGHT_PRIORITY`, `PEDESTRIAN_CROSSING`, `YIELD`, `NO_ENGINE_BRAKE`, `ENDOF_NO_ENGINE_BRAKE`, `NO_IDLING`, `TRUCK_ROLLOVER`, `LOW_GEAR`, `ENDOF_LOW_GEAR`, `LIGHT`, `DOUBLE_HAIRPIN`, `TRIPLE_HAIRPIN`, `TWO_WAY_TRAFFIC`, `URBAN_AREA`, `HUMP_BRIDGE`, `UNEVEN_ROAD`, `BICYCLE_CROSSING`, `YIELD_TO_BICYCLES`, `NO_TOWED_CARAVAN`, `NO_TOWED_TRAILER`, `NO_CAMPER`, `NO_TURN_ON_RED`, `TURN_ON_RED`, `EMBANKMENT`, `FLOOD_AREA`, `OBSTACLE`, `ROAD_SPLIT`. - `EVT_WAYPOINTS`: Sub option of `EVENT` option. Returns the waypoints of route in event structure. A waypoint is a coordinate with properties that can be used to reproduce the computed route on other device or server. - `departureTime` (string): This parameter is an EPOCH timestamp in milliseconds (UTC) or a string with ISO local date time format like '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'. It is used to define the date and time of routing departure. - `adjustEta` (boolean): Defines if the calculated route's ETA should match with field `time` of input `destinations` (GPS time in milliseconds (EPOCH)). The field `time` of input `destinations` must be filled. - `allowOffRoad` (boolean): Defines if the returned route are computed with off-roads. Otherwise, no off-road are created. True by default. - `corridorRadius` (integer (int32)): Builds a corridor along the calculated route with the given radius. Corridor radius in meters (notes: the corridor width = 2 * `corridorRadius`). - `fenceShapes` (GeoFenceShp[]): Defines fence shapes to perform an intersection test between the route and the fences. - `center` (Coordinate, required): Center of circle fence. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `radius` (integer (int64), required): Radius of circle fence. - `vertices` (Coordinate[], required): Vertices of polygon fence. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `id` (integer (int64)): The fence id. If value is negative the server will set it with an auto-incrementing number. - `type` (enum): Define the type of geometric shape of fence, like CIRCLE or POLYGON. - `CIRCLE`: Circle. - `POLYGON`: Polygon. - `language` (string): Defines the preferred language that will be used by the options `ROUTESHEET`, `EVT_ROUTESHEET`, `REVGEO_POSTAL_ADDRESS`, etc. Values of language code: An ASCII string that defines an (ISO 639-1)[https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1] (2-letter) language code. - `customData` (CustomDt[]): Custom data. The parameter customData can be repeated and contains a key and value. - `key` (string) - `value` (string) ## Response ### Details of fields - `usedDestinations` (RoutingUsedDest[]): List of used destinations according to the request. The coordinates used for routing calculation: includes the raw coordinates and the map matched coordinates. - `inputOrder` (integer (int32)): Original order number of input coordinates. - `used` (boolean): Indicates if this coordinate has been used by the routing calculator. - `usedOrder` (integer (int32)): Final order number of input coordinates. The order can be changed by options `OPTIMIZED_TRIP`, `OPTIMIZED_TRIP_CLOSE`, `OPTIMIZED_TRIP_ROUND`, `OPTIMIZED_TRIP_UNDEFSTOP`. - `matchedCoordinateGps` (CoordinateSat): Map matched coordinate (i.e. snapped on a map road element). - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `heading` (number (double)): Heading in degrees. - `speed` (number (float)): Speed in km/h. - `time` (integer (int64)): GPS time in milliseconds (EPOCH). - `sat` (integer (int32)): Number of GPS satellites available. - `matchedPostalAddress` (Address): Postal address of map matched coordinate. - `countryCode` (string): ISO code of country. - `country` (string): Country name. - `state` (string): State name. - `county` (string): County name. - `city` (string): City name. - `district` (string): District name of city. - `postalCode` (string): Postal code. - `roadNumber` (string): Road number. - `street` (string): Street name. - `streetNumber` (string): House number. - `oppositeStreetNumber` (string, deprecated): Opposite street number. - `confidenceValue` (number (double)): Confidence score of map matched coordinate in range ]0,1]. - `distanceFromRequest` (number (double)): Distance in meters between raw coordinate and map matched coordinate. - `exceptionMessage` (string): The exception message of the destination. Returned only when the option `REVGEO_STRICT_DISABLE` is defined in request. - `polylineIndex` (integer (int64), deprecated): The index of corresponding coordinate in route's polyline. Only when the option `POLYLINE_INDEX` is defined in request, otherwise the value is set to `-1`. - `waypointPolylineIndex` (integer (int32), deprecated) - `duration` (integer (int64)): The travel time (ETA) in seconds from start coordinate of this destination. - `length` (integer (int64)): The length in meters from start coordinate of this destination. - `customData` (CustomDt[]): Custom data is a list that can be used to set some custom information about the destination in input. - `key` (string) - `value` (string) - `routingRoutes` (RoutingRt[]): Defines a list of computed routes. - `exceptionMessage` (string): Error message returned when the route is not feasible. - `length` (integer (int64)): Length of route in meters. - `duration` (integer (int64)): Total driving time in seconds. - `totalDuration` (integer (int64)): The total duration in seconds represent the duration of travel + stop time. - `trafficDelay` (integer (int64)): Delay in seconds due to real time traffic and statistical traffic. - `departureTime` (integer (int64)) - `arrivalTime` (integer (int64)) - `averageSpeed` (number (float)): Average speed in km/h. - `maximumSpeed` (number (float)): Maximum speed in km/h. - `startUTurnThreshold` (integer (int32)): The start UTurn threshold. This value determines, at start point or any via point for which a use start angle / avoid UTurn property is set, the threshold (in 1/10th seconds / meters / Wh in resp. FASTEST / SHORTEST / ECO mode) above which the property may be ignored. For instance, in SHORTEST mode, if the route from start to stop leaving start point in the desired direction is more than `startUTurnThreshold` meters longer than the route from start to stop leaving start point in the opposite direction, leave the start point in the opposite direction. - `energyConsumption` (number (double)): Energy needed to travel route, in kWh. See options `ENERGY_CONSUMPTION`, `EVT_ENERGY_CONSUMPTION`. - `routingTollCost` (RoutingTollCst): Total toll cost range along the route. See option `EVT_TOLL_COST`. - `tolls` (Tol[]): List of tolls. - `tollType` (enum): Type of toll. - `TOLL_FIXED_FEE`: Fixed fee (does not depend of origin). - `TOLL_OBTAIN_TICKET`: Obtain ticket (no fee). - `TOLL_PAY_PER_TICKET`: Pay per ticket (depends of origin). - `TOLL_ELECTRONIC`: Electronic. - `meanOfPayments` (enum[]): List of mean of payment. - `PAYMENT_CASH`: Cash. - `PAYMENT_BANK_CARD`: Bank card. - `PAYMENT_CREDIT_CARD`: Credit card. - `PAYMENT_PASS_SUBSCRIPTION`: Pass or subscription. - `PAYMENT_TRANSPONDER`: Transponder. - `PAYMENT_VIDEO_TOLL_CHARGE`: Video toll charge. - `PAYMENT_EXACT_CASH`: Exact cash. - `PAYMENT_TRAVEL_CARD`: Travel card. - `polylineIndex` (integer (int64)): Index of polyline coordinate. - `tollCharges` (TollChrg[]): List of toll charge. - `currency` (string): Currency unit in norm ISO 4217, more details on [Wikipedia ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `category` (string): A textual definition of vehicle category. - `price` (number (double)): Price. - `coordinate` (Coordinate): Coordinate of toll. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `sumFees` (RoutingSumF[]): List of total toll fees of route. In most cases this list contains only one entry. Only when the toll fees along the route use several currencies will the list contains several entries (one for each currency). - `currency` (string): Currency in norm ISO 4217, more details on Wikipedia ISO 4217 https://en.wikipedia.org/wiki/ISO_4217. - `feeMin` (number (double)): The minimum fee. - `feeMax` (number (double)): The maximum fee. - `routingTaxCost` (RoutingTaxCst): Total tax cost range along the route. See option `EVT_TAX_COST`. - `taxSections` (RoutingTaxSect[]): List of tax sections. - `taxCategory` (enum): Tax category. - `TAX_CATEGORY_NONE`: No tax. - `TAX_CATEGORY_1`: Tax category 1. - `TAX_CATEGORY_2`: Tax category 2. - `TAX_CATEGORY_3`: Tax category 3. - `meanOfPayments` (enum[]): List of mean of payment. - `PAYMENT_CASH`: Cash. - `PAYMENT_BANK_CARD`: Bank card. - `PAYMENT_CREDIT_CARD`: Credit card. - `PAYMENT_PASS_SUBSCRIPTION`: Pass or subscription. - `PAYMENT_TRANSPONDER`: Transponder. - `PAYMENT_VIDEO_TOLL_CHARGE`: Video toll charge. - `PAYMENT_EXACT_CASH`: Exact cash. - `PAYMENT_TRAVEL_CARD`: Travel card. - `countryCode` (string): The ISO country code ([ISO 3166 alpha 3](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)) of current tax section. - `length` (integer (int32)): Length of section in meters. - `firstFrmIdx` (integer (int32)): Index of the first route's segment event of the tax section. See the options `EVENT`, `EVT_POLYLINE`, `EVT_SEGMENT_INFO`. - `lastFrmIdx` (integer (int32)): Index of the last route's segment event of the tax section. See the options `EVENT`, `EVT_POLYLINE`, `EVT_SEGMENT_INFO`. - `taxCharges` (TaxChrg[]): List of tax charge. - `currency` (string): Currency in norm ISO 4217, more details on Wikipedia ISO 4217 https://en.wikipedia.org/wiki/ISO_4217. - `category` (string): A textual definition of vehicle category. - `price` (number (double)): Price. - `sumFees` (RoutingSumF[]): List of total tax fees of route. In most cases this list contains only one entry. Only when the tax fees along the route use several currencies will the list contains several entries (one for each currency). - `currency` (string): Currency in norm ISO 4217, more details on Wikipedia ISO 4217 https://en.wikipedia.org/wiki/ISO_4217. - `feeMin` (number (double)): The minimum fee. - `feeMax` (number (double)): The maximum fee. - `routingInstructions` (RoutingInstruc[]): List of guidance instructions. Use `ROUTESHEET` option in request. - `type` (enum): Instruction type. - `FOLLOW`: Follow. - `FOLLOW_SIGN`: Follow sign. - `TAKE_RAMP`: Take ramp. - `ENTER_MOTORWAY`: Enter in motorway. - `EXIT_MOTORWAY`: Exit from motorway. - `ENTER_ROUNDABOUT`: Enter in roundabout. - `EXIT_ROUNDABOUT`: Exit from roundabout. - `TAKE_FERRY`: Take ferry. - `LEAVE_FERRY`: Leave ferry. - `STOP`: Stop. - `STOP_VIA`: Stop on via. - `geoElementType` (enum): Geo element type following instruction. - `ALL_ROAD`: Road types. - `PEDESTRIAN` - `ROUNDABOUT` - `SLIP_ROAD` - `ROAD` - `MOTORWAY` - `FERRY` - `MAIN_ROAD`: Road levels. - `SECONDARY_ROAD` - `TERTIARY_ROAD` - `FOURTH_ROAD` - `COUNTRY`: Administrative. - `STATE` - `COUNTY` - `CITY` - `DISTRICT` - `POSTAL_CODE` - `BUILT_UP_AREA_NA`: Urban area information not available. - `BUILT_UP_AREA_NONE`: No urban area. - `BUILT_UP_AREA_MAIN`: Urban area coverage size main, not an administrative area. - `BUILT_UP_AREA_MEDIUM`: Urban area coverage size medium (not an administrative area). - `BUILT_UP_AREA_SMALL`: Urban area coverage size small (not an administrative area). - `VEHICLE_REPAIR`: POI. - `PETROL_STATION` - `RENT_A_CAR` - `PARKING_GARAGE` - `HOTEL_MOTEL` - `RESTAURANT` - `TOURIST_OFFICE` - `MUSEUM` - `THEATRE` - `CULTURAL_CENTRE` - `SPORTS_ACTIVITY` - `HOSPITAL` - `POLICE_STATION` - `CITY_HALL` - `POST_OFFICE` - `PHARMACY` - `BANK` - `CAMPING` - `SHOPPING_CENTRE` - `STADIUM` - `TOURIST_ATTRACTION` - `BUS_STATION` - `EXHIBITION_CENTER` - `GOLF_COURSE` - `GROCERY_STORE` - `LIBRARY` - `MARINA` - `HISTORICAL_MONUMENT` - `BOWLING` - `CASINO` - `CINEMA` - `SPORTS_CENTRE` - `BEACH` - `SHOP` - `OPERA` - `TENNIS_COURT` - `MUSIC_CENTER` - `AMUSEMENT_PARK` - `ZOO` - `length` (integer (int32)): Distance in meters of current instruction. - `duration` (integer (int32)): Duration in seconds of current instruction. - `fromName` (string): Name of last road segment before the maneuver. In specified language define in request, if available in map data - `fromPhoneme` (string): Phonetic transcription of the name of last road segment before the maneuver. In specified language define in request, if available in map data - `manoeuvre` (enum): The direction to follow. - `STRAIGHT`: Straight ahead. - `SLIGHT_LEFT`: Turn slight left. - `LEFT`: Turn left. - `SHARP_LEFT`: Turn sharp left. - `U_TURN`: Make a u-turn. - `SHARP_RIGHT`: Turn sharp right. - `RIGHT`: Turn right. - `SLIGHT_RIGHT`: Turn slight right. - `BEAR_LEFT`: Bear left. - `BEAR_RIGHT`: Bear right. - `coordinate` (Coordinate): Position of the maneuver. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `roundAboutExitNumber` (integer (int32)): The exit number of a roundabout. - `toName` (string): Name (or sign post) of first road segment after the maneuver. In specified language define in request, if available in map data - `toOn` (string): Returns the Official Name of next route section (in specified language code if available). - `toOnPhoneme` (string): Returns phonetic transcription of the official name of next route section. - `toPhoneme` (string): Phonetic transcription of the name (or sign post) of first road segment after the maneuver. In specified language define in request, if available in map data - `toRn` (string): Route number of first road segment after the maneuver. - `toRnPhoneme` (string): Phonetic transcription of the route number of first road segment after the maneuver. - `toSi` (string): Sign post to follow after the maneuver. In specified language define in request, if available in map data. - `toSiPhoneme` (string): Phonetic transcription of the sign post to follow after the maneuver. In specified language define in request, if available in map data. - `textDist` (string): Distance instruction in human readable format can be used with text-to-speech. - `text` (string): Instruction in human readable format can be used with text-to-speech. - `polylineIndex` (integer (int32), deprecated): Index in route polyline's points array of first form of this instruction. Deprecated use instead `EVENT`, `EVT_ROUTESHEET` with `EVT_POLYLINE` or `EVT_ENCODED_POLYLINE`. - `boundingBox` (BoundingBox): Bounding box of the route. - `minLon` (number (double)): Minimum longitude, in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). - `minLat` (number (double)): Minimum latitude, in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). - `maxLon` (number (double)): Maximum longitude, in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). - `maxLat` (number (double)): Maximum latitude, in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). - `corridor` (GeometricPoly[]): Corridor around the route. Use the parameter `corridorRadius` in request. - `coordinates` (Coordinate[]): Coordinates of the polygon. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `fenceResults` (GeoFenceRes[]): List of tested fences. - `id` (integer (int64)): Unique ID of fence. - `type` (enum): Type of geometry. - `CIRCLE`: Circle. - `POLYGON`: Polygon. - `fenceShape` (GeoFenceShp): Shape of fence used to perform the test. - `center` (Coordinate, required): Center of circle fence. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `radius` (integer (int64), required): Radius of circle fence. - `vertices` (Coordinate[], required): Vertices of polygon fence. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `id` (integer (int64)): The fence id. If value is negative the server will set it with an auto-incrementing number. - `type` (enum): Define the type of geometric shape of fence, like CIRCLE or POLYGON. - `CIRCLE`: Circle. - `POLYGON`: Polygon. - `positionState` (enum): Defines position state of tested coordinate on the fence geometry. - `INWARD`: Defines if the tested coordinate is an inward intersection. - `INSIDE`: Defines if the tested coordinate is in fence. - `OUTWARD`: Defines if the tested coordinate is an outward intersection. - `OUTSIDE`: Defines if the tested coordinate is out of fence. - `INTERSECT`: Position is not completely inside or outside but the shapes are intersected. - `position` (Coordinate): The coordinates of the intersection in WGS84. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `timestamp` (integer (int64)): The estimated time stamp of this intersection in milliseconds. - `startStopInfo` (RoutingRouteStartStopInf): Information about the start and stop coordinates of a route found by the routing calculation. - `start` (Coordinate): Start (first) coordinate of the computed route. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `stop` (Coordinate): Stop (last) coordinate of the computed route. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `distanceFirstMatched` (number (double)): Distance between first matched coordinate and the start coordinate of route found by the routing calculation. This distance is not 0 when the input matched coordinate is unaccessible. - `distanceLastMatched` (number (double)): Distance between last matched coordinate and the stop coordinate of route found by the routing calculation. This distance is not 0 when the input matched coordinate is unaccessible. - `interDests` (Coordinate[]): List of intermediate destination coordinates reached by the computed route. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `polyline` (Coordinate[]): Route polyline geometry. See the option `POLYLINE`. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `detailedPolylines` (GeometricDetPolyline[], deprecated): Polyline geometry of itinerary with more information for each sub-segments. See the option `DETAILED_POLYLINE`. Deprecated Use events system (like `EVENT`, `EVT_POLYLINE`) instead. - `coordinates` (Coordinate[]): Matched coordinate on a road. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `length` (integer (int64)): Length of route segment in meters. - `openLrBase64` (string): Route geometry encoded as OpenLR (in base64 encoding). - `segmentIds` (integer (int64)[], deprecated): List of segment ID of computed route. - `roadSegments` (RoadSeg[], deprecated): Route segments. Deprecated use events system (like `EVENT`, `EVT_SEGMENT_INFO`, `EVT_POLYLINE`) instead. - `countryCode` (string): Country code (ISO). - `id` (integer (int64)): ID of segment. -1 if information is not available. - `reverseDirection` (boolean): True if this segment has been reversed, false otherwise. - `duration` (number (double)): The duration in seconds to travel through this route segment. -1 if information is not available. - `weight` (integer (int64)): The weight in seconds or meters to travel through this route, used only by isochrone calculation. -1 if information is not available. - `from` (Coordinate): Coordinate of first point. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `to` (Coordinate): Coordinate of last point. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `junctionNodes` (Coordinate[], deprecated): Junction nodes of route. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `waypoints` (RoutingWaypnt[]): Waypoints of route. - `usedDestinationIndex` (integer (int32)): The index of the used destinations (destinations). -1 if not available. - `polylineIndex` (integer (int32), deprecated): The index of the waypoint polyline. -1 if not available. - `waypointPolylineIndex` (integer (int32)): The coordinate index of the waypoint polyline. - `coordinate` (Coordinate): Coordinate of waypoint. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `angle` (number (double)): Angle in degrees of the road segment (clock-wise). - `radius` (integer (int64)): Radius (in meters) of the waypoint. - `uturn` (boolean): Defines if a UTurn is done on this via point. - `ignorePoint` (boolean): Defines if this waypoint is ignored by the planner for its route calculation. - `ignoreTrafficDirections` (boolean): Defines if traffic directions should be ignored by route planner between this waypoint and next one. - `ignoreRoadBlocks` (boolean): Defines if road blocks should be ignored by route planner between this waypoint and next one. - `ignoreRestrictions` (boolean): Defines if forbidden manoeuvres and blocked passages should be ignored by route planner between this waypoint and next one. - `avoidUTurn` (enum): Defines if a UTurn should be avoided (if possible) by route planner at this location. - `UNDEF`: Status undefined. - `YES`: Status yes. - `NO`: Status no. - `useStartAngle` (enum): If set to `YES` and location is on is on a 2 way road, location's angle will be used as a general direction for departure from location. - `UNDEF`: Status undefined. - `YES`: Status yes. - `NO`: Status no. - `useStopRoadSide` (enum): Defines if route planner must arrive on this waypoint on waypoint's side (if waypoint is on a 2 way road). - `UNDEF`: Status undefined. - `YES`: Status yes. - `NO`: Status no. - `offRoad` (RoutingOffRd): Polyline representing the offroad section following this waypoint. - `geometry` (Coordinate[]): Geometry representing the offroad section. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `attributes` (AttributeItem[]): Attributes. - `attributeCode` (enum): BeNomad Code of attribute. - `__NOT_MAPPED`: Not mapped value. - `KEY`: Key. - `FEATURE_CLASS_CODE`: FCC = feature class code. - `INCLUSION_RELATION`: LAB = Inclusion relation. - `SELF_REF`: For SIV/VB SDK dynamic objects (self reference). - `ADMINISTRATIVE_CLASS`: AC = administrative class of a city (0: capital of a country, 1: capital of an order 1 area, etc.). - `ARABIC_ENGLISH_NAME`: AE = ARABIC ENGLISH name (latin alphabet). - `ARABIC_NAME`: AR = ARABIC name (arabic alphabet). - `ASSAMESE_NAME`: AS = ASSAMESE name (alphabet). - `ASSAMESE_LATIN_NAME`: AX = ASSAMESE_LATIN name (alphabet). - `AZERBAIJANI_NAME`: AZ = AZERBAIJANI name. - `BELARUSIAN_NAME`: BE = BELARUSIAN name (cyrillic alphabet). - `BULGARIAN_NAME`: BG = BULGARIAN name (cyrillic alphabet). - `BULGARIAN_LATIN_NAME`: BL = BULGARIAN name (latin alphabet). - `LANDMARK`: BM = 2D-Landmark meta data. - `BRAND_NAME`: BN = brand name. - `BOSNIAN_NAME`: BS = BOSNIAN name. - `BELARUSIAN_LATIN_NAME`: BT = BELARUSIAN name (latin alphabet). - `BENGALI_NAME`: BI = BENGALI name. - `BENGALI_LATIN_NAME`: BX = BENGALI name (latin alphabet). - `CATALAN_NAME`: CA = CATALAN name. - `COUNTRY_CODE`: CC = Country code. - `ENCODING`: CH = character encoding. - `COORDINATE_TYPE`: CO = coordinates' sytem. - `CZECH_NAME`: CS = CZECH name. - `WELSH_NAME`: CY = WELSH name. - `DANISH_NAME`: DA = DANISH name. - `GERMAN_NAME`: DE = GERMAN name. - `TRAFFIC_DIRECTION`: DF = direction of traffic flow. - `EXTRA_ATTRIBUTE`: EA = extra attributes for POIs objects. - `GREEK_GREEK_NAME`: EG = GREEK name (greek alphabet). - `GREEK_NAME`: EL = GREEK name (latin alphabet). - `ENGLISH_NAME`: EN = ENGLISH name. - `SPANISH_NAME`: ES = SPANISH name. - `ESTONIAN_NAME`: ET = ESTONIAN name. - `BASQUE_NAME`: EU = BASQUE name. - `FINNISH_NAME`: FI = FINNISH name. - `SOURCE_FORMAT`: F0 = source format. - `FRENCH_NAME`: FR = FRENCH name. - `FRISIAN_NAME`: FY = FRISISAN name. - `IRISH_NAME`: GA = IRISH name. - `GAELIC_NAME`: GD = GAELIC name. - `GALICIAN_NAME`: GL = GALICIAN name. - `GUARANI_NAME`: GN = GUARANI name. - `GEORGIAN_LATIN_NAME`: GT = GEORGIAN_LATIN name. - `GUJARATI_NAME`: GU = GUJARATI name. - `GUJARATI_LATIN_NAME`: GX = GUJARATI_LATIN name. - `HEADER`: HD = header. - `HEBREW_NAME`: HE = HEBREW name. - `HINDI_NAME`: HI = HINDI name. - `HEBREW_LATIN_NAME`: HL = HEBREW name (latin). - `ALPHA_HOUSE_NUMBER`: HN = Alphanumerical house number. - `HINDI_LATIN_NAME`: HT = HINDI name (latin). - `HUNGARIAN_NAME`: HU = HUNGARIAN name. - `INTERNATIONAL_CODE`: IC = international code. - `INDONESIAN_NAME`: IN = INDONESIAN name (ID reserved for LinkIDs). - `ICELANDIC_NAME`: IS = ICELANDIC name. - `ITALIAN_NAME`: IT = ITALIAN name. - `JAPAN_NAME`: JA = JAPAN name. - `JAPAN_LATIN_NAME`: JL = JAPAN name (latin). - `KANNADA_NAME`: KA = KANNADA name (latin). - `KAZAKH_NAME`: KK = KAZAKH name. - `KAZAKH_LATIN_NAME`: KL = KAZAKH name (latin alphabet). - `KOREAN_NAME`: KO = KOREAN name. - `KOREAN_LATIN_NAME`: KT = KOREAN name (latin). - `KANNADA_LATIN_NAME`: KX = KANNADA_LATIN name (latin). - `LANGUAGE`: LA = language for objects' names. - `LETZEBURGESCH_NAME`: LB = LETZEBURGESCH name. - `HOUSE_NUMBER_LEFT`: LE = House number left. - `LENGTH`: LG = length in meters. - `LANDMARK_3D`: LM = 3D landmark texture. - `LANE_NUMBER`: LN = number of lanes. - `LEGAL_SPEED`: LS = Legal Speed. - `LITHUANIAN_NAME`: LT = LITHUANIAN name. - `LATVIAN_NAME`: LV = LATVIAN name. - `MALAYALAM_NAME`: MA = Malayalam name. - `MACEDONIAN_LATIN_NAME`: MC = MACEDONIAN name (latin alphabet). - `MACEDONIAN_NAME`: MK = MACEDONIAN name (cyrillic alphabet). - `MOLDAVIAN_NAME`: MO = MOLDAVIAN name. - `METRO`: MO = Metro (0 : not a metro station; 1 : metro station). - `MALAY_NAME`: MS = MALAY name. - `MALTESE_NAME`: MT = MALTESE name. - `NB_BORDER_JUNCTIONS`: NB = Number border junctions. - `NB_JUNCTIONS`: NJ = Number junctions. - `DUTCH_NAME`: NL = DUTCH name. - `NORWEGIAN_NAME`: NO = NORWEGIAN name. - `STREET_NAME_AND_HOUSE_NUMBER`: NS = Street name and house number. - `OFFICIAL_CODE`: OC = Official Code. - `NAME`: ON = Official Name. - `POPULATION_CATEGORY`: PC = Population Category. - `POPULATION`: PO = Population. - `POLISH_NAME`: PL = POLISH name. - `DATA_PROVIDER`: PR = data provider's name. - `POSTAL_CODE`: PS = postal code. - `PORTUGUESE_NAME`: PT = PORTUGUESE name. - `HOUSE_NUMBER_RIGHT`: RE = House number right. - `RUSSIAN_LATIN_NAME`: RL = RUSSIAN name (latin alphabet). - `RHAETO_ROMANCE_NAME`: RM = RHAETO-ROMANCE name. - `ROUTE_NUMBER`: RN = Route number (ex. E15, A6, N7, etc.). - `ROMANIAN_NAME`: RO = ROMANIAN name. - `RUSSIAN_NAME`: RU = RUSSIAN name (cyrillic alphabet). - `SCALE`: SC = coordinates' scale. - `SERBO_CROATIAN_NAME`: SH = SERBO-CROATIAN name. - `SIGN_INFORMATION`: SI = sign information. - `SLOVAK_NAME`: SK = SLOVAK name. - `SLOVENIAN_NAME`: SL = SLOVENIAN name. - `SPEED_CATEGORY`: SP = speed category (km/h): 0=10;1=20;2=30;3=40;4=50;5=60;6=70;7=80;8=90;9=100;10=110;11=120. - `ALBANIAN_NAME`: SQ = ALBANIAN name. - `SERBO_CROATIAN_LATIN_NAME`: SR = SERBO-CROATIAN name (latin alphabet). - `SVS_TYPE`: ST = SVS type. - `SWEDISH_NAME`: SV = SWEDISH name. - `TRUCK_ATT_TIME_DOMAIN_ATTRIBUTE`: T0 = Truck Attribute with a Time domain Attribute. - `TRUCK_ATTRIBUTE`: TA = Truck Attribute. - `TIME_DOMAIN_ATTRIBUTE`: TD = Time domain Attribute. - `TEXTURE_COORD`: TE = Texture coordinates (for 3D landmarks). - `THAI_NAME`: TH = THAI name. - `TRAFIC_INFO`: TI = Traffic Info Attribute. - `TELEPHONE`: TL = telephone number. - `TMC_LOCATION`: TM = TMC location. - `TOLL_ROAD`: TR = toll road. - `TURKISH_NAME`: TU = TURKISH name. - `THAI_LATIN_NAME`: TX = THAI name (latin alphabet). - `UKRAINIAN_NAME`: UK = UKRAINIAN name (cyrillic alphabet). - `UKRAINIAN_LATIN_NAME`: UL = UKRAINIAN name (latin alphabet). - `UTM_ZONE`: UT = UTM zone : 1 - 60, positif for north, negative for south. - `VIETNAMESE_NAME`: VI = VIETNAMESE name. - `VIETNAMESE_LATIN_NAME`: VL = VIETNAMESE name (latin alphabet). - `VALENCIAN_NAME`: VL = VALENCIAN name. - `VT_MASK`: VT = vehicle type mask. - `ANY_LANG`: XX = Any language code. - `CHINESE_NAME`: ZH = Chinese name. - `CHINESE_LATIN_NAME`: ZL = Chinese name (latin alphabet). - `key` (string): BeNomad key of attribute. - `numericKey` (integer (int32)): Numeric key. - `rawData` (boolean): BeNomad raw data. - `type` (enum): Data type. - `NA` - `BOOLEAN` - `BYTE` - `BYTES` - `CHAR` - `DOUBLE` - `FLOAT` - `INT` - `LONG` - `STRING` - `KEY` - `LABEL` - `META` - `UINT` - `value` (string): Data value. - `waypointPolyline` (Coordinate[]): Waypoints polyline of route. This polyline is composed of the coordinates of the route with inserted waypoint matched coordinates. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `events` (RoutingEvnt[]): Events on road. See the `EVENT` option. - `type` (enum): Type of event. - `SEGMENT`: Each entry values come from the road segmentation of map data. - `SAMPLING_TIME`: Each entry values are sampled by time. - `SAMPLING_DISTANCE`: Each entry values are sampled by distance. - `distanceUnit` (string): Defines the distance unit. - `timeUnit` (string): Defines the time unit. - `markers` (RoutingEvntMarker[]): List of markers. - `distance` (integer (int64)): The travel distance from start of the route. - `time` (integer (int64)): The travel time from start of the route. - `percent` (number (double)): The percentage of distance from start of the route. - `coordinate` (Coordinate): The coordinate of the marker. - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`. - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`. - `entries` (RoutingEvntEntry[]): List of entries. - `type` (string): Type of entry. - `name` (string): Name of entry. - `jsonObject` (any): Representation of object value by JSON. ### Response samples JSON Sample: ```javascript { "usedDestinations": [ { "inputOrder": 0, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.065868896076492, "lat": 43.616005 }, "confidenceValue": 0.2072894015379406, "distanceFromRequest": 0.2072894015379406, "polylineIndex": -1, "duration": -1, "length": -1 }, { "inputOrder": 1, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.066398283397998, "lat": 43.616205 }, "confidenceValue": 0.3909592926804005, "distanceFromRequest": 0.3909592926804005, "polylineIndex": -1, "duration": 17, "length": 56 }, { "inputOrder": 2, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.078628713869563, "lat": 43.61534125 }, "confidenceValue": 0.9983651054630179, "distanceFromRequest": 0.9983651054630179, "polylineIndex": -1, "duration": 120, "length": 1154 }, { "inputOrder": 3, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.080403748959592, "lat": 43.6147275 }, "confidenceValue": 0.5836206092537323, "distanceFromRequest": 0.5836206092537323, "polylineIndex": -1, "duration": 138, "length": 1350 }, { "inputOrder": 4, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.07845, "lat": 43.61179 }, "confidenceValue": 0.23959387567291845, "distanceFromRequest": 0.23959387567291845, "polylineIndex": -1, "duration": 176, "length": 1746 }, { "inputOrder": 5, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.07866, "lat": 43.61185 }, "confidenceValue": 0.28812487861800623, "distanceFromRequest": 0.28812487861800623, "polylineIndex": -1, "duration": 178, "length": 1764 }, { "inputOrder": 6, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.079119995852384, "lat": 43.6128825 }, "confidenceValue": 0.41855910191836315, "distanceFromRequest": 0.41855910191836315, "polylineIndex": -1, "duration": 192, "length": 1892 }, { "inputOrder": 7, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.08141, "lat": 43.61161 }, "confidenceValue": 1.0, "distanceFromRequest": 1.0, "polylineIndex": -1, "duration": 223, "length": 2148 }, { "inputOrder": 8, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.0811, "lat": 43.6117 }, "confidenceValue": 1.0, "distanceFromRequest": 1.0, "polylineIndex": -1, "duration": 227, "length": 2175 }, { "inputOrder": 9, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.0812, "lat": 43.6119 }, "confidenceValue": 1.0, "distanceFromRequest": 1.0, "polylineIndex": -1, "duration": 230, "length": 2199 }, { "inputOrder": 10, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.081468042538314, "lat": 43.61183298936542 }, "confidenceValue": 1.0, "distanceFromRequest": 1.0, "polylineIndex": -1, "duration": 233, "length": 2221 }, { "inputOrder": 11, "used": true, "usedOrder": 0, "matchedCoordinateGps": { "time": 0, "lon": 7.0814, "lat": 43.61162 }, "confidenceValue": 1.0, "distanceFromRequest": 1.0, "polylineIndex": -1, "duration": 238, "length": 2258 } ], "routingRoutes": [ { "length": 2258, "duration": 238, "trafficDelay": 0, "averageSpeed": 34.15462, "maximumSpeed": 0.0, "startUTurnThreshold": 3000, "startStopInfo": { "start": { "lon": 7.06587, "lat": 43.61601 }, "stop": { "lon": 7.0814, "lat": 43.61162 }, "distanceFirstMatched": 0.56, "distanceLastMatched": 0.0, "interDests": null } } ] } ```