VIAMICHELIN REST API


findpoinearroute

Description

Searches static POI along a route matching criteria given as parameters. POI are hosted at ViaMichelin in a database.

URL

http://apir.viamichelin.com/apir/1/FindPOINearRoute.{output}?steps={dep};[{steps};]{arr}&lg={lg}&db={db}&dist={dist}&time={time}&favMotorways={favMotorways}&avoidBorders={avoidBorders}&avoidTolls={avoidTolls}&avoidCCZ={avoidCCZ}&avoidORC={avoidORC}&nb={nb}&veht={veht}&itit={itit}&c[i]={c[i]}&authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format

xml, json

Billing

A proximity search = Charged request (whetever the number of results)

Changelog

VersionDescription
1.0 Added to REST API

 

Input settings

NameMandatory?Data typeDescriptionDefault
db yes string Database unique identifier (given by ViaMichelin) N/A
lg yes string Language code (fra, deu, spa, ita, eng, ces, dan, nld, fin, int, nor, pol, por, swe) N/A
steps yes (1=xy | 2=poiid | 3=locid):('e'=step | 'p'=waypoint):( lon:lat | db:poiid | locid) List of steps. Each step is structured as step type:step mode: complementary data.
Steps are separated by ';'
N/A
dist no positive integer Search radius in meters (from 0 to 200,000). 10000
time no positive integer Time limit to reach the POI in seconds (from 60 to 7,200). 600
avoidBorders no bool Specifies if the route should avoid crossing borders. false
avoidTolls no bool Specifies if the route should avoid tolls. false
avoidCCZ no bool Specifies if the route should avoid Congestion Charge Zones. false
avoidORC no bool Specifies if the route should avoid off-road connections (ferry, train etc). false
nb no positive integer Number of returned POI (from 1 to 100). 20
veht no 0:Car | 1:Truck Type of vehicle used by the itinerary calculation. For example, with truck vehicle the calculation favours the motorway and decreases the speed average. Car
itit no 0:Michelin recommended | 1:Quickest | 2:Shortest Type of itinerary to be calculated.
Recommended: focuses on road safety and comfort while offering a good compromise between time and distance.
Quickest provides the fastest route by emphasising motorways and major roads.
Shortest optimises distance.
Michelin recommended
c[i] no integer Filter on the result dataset according to the value of the numeric metadata [i]. this parameter can be multi-valued. The semantics of the metadata is specific to each database of POIs.
For example if you want to get POIs with metanum 1 set to 1 and metanum 2 set to 1 or 2, you write ...&c1=1&c2=1; 2&....
empty
name no string Filter on POIs name. empty
authkey yes string Authentication key. This could be a JS key, a token generated by the token function, or the client's id if request is signed (see signature parameter). N/A
signature no string Request signed with the HMAC-SHA1 method where client's password is the secret key. If request signed, authKey must be valued with client's id, and expires must also be valued. URL strings must be URL-encoded before signing. empty
expires no except if signature valued date Expiration GMT date in yyyy-MM-dd'T'HH:mm:ss.SSS`'Z format. vide
callback yes if json string Callback function name (applied only if output is json) empty
charset no string Response encoding charset 'ISO-8859-1'
ie no string Request encoding charset 'ISO-8859-1'

 

Constraints

  • A request cannot return more than 100 POI so nb have to be lower.
  • Spatial search radius dist has to be higher than 100m and lower than 200km.
  • Route planner availability is dependant on geographic coverage that change from one country to another. ViaMichelin improves continuously this coverage.
  • Number of steps cannot exceed 8, departure and arrival included.
  • Spatial search radius dist has to be higher than 100m and lower than 200km.
  • A request cannot return more than 100 POI so nb have to be lower.
  • Time search radius time has to be lower than 7200s (2h).

 

Request samples

 

Response structure

  • A structure of poiList open in new tab
  •  

Please note that unexplained data fields are intended for internal ViaMichelin use only. These can change at any moment and should not be considered for use. Their existence highlights the fact that ViaMichelin uses the same services and technical infrastructure internally as its business clients.

Retour haut de page