VIAMICHELIN SOAP API


FindNearbyInputPOIByRoad

Description 

This method finds a list of «dynamic» points of interest (POI defined by an identifier a geographic position) located around a central point. This method uses the road to search for POI unlike the findNearbyInputPOI method, which is as the crow flies. 

 

Specifications 

  • The method cannot find POI which are more than 200 000 meters (by road) from the origin point.
  • The minimum search radius is 1 000 meters. Under this limit, any value will be treated as equal to 1 000.
  • The method cannot find POI which are more than 7200 seconds away from the origin point.
  • The list of «dynamic» POI can contain up to 30 items. Beyond this limit a SOAP fault is returned.
Input Parameters 

 Parameter  Mandatory  Description
request
(FindNearbyInputPOIByRoadRequest)
true contains the specifications of the POI search:
- the specification of the dataset on which to perform search,
- the specification of the search parameters (search central point, ...),
- and the specification of the format of the search result dataset.
authenticationParams
(String)
true Specifies an authentication identifier for accessing Web Service: login + '|' character + password

Output Parameter 

 Parameter  Description
FoundLocationList The complete description of the set of POI found.

Use 

To search by road a list of «dynamic» points of interest (POI defined by an identifier a geographic position) located around a central point, you must specify the following attributes in the «request» parameter of the method (see FindNearbyInputPOIByRoadRequest structure):
  • searchDataset attribute (see InputPOI) which contains the specification of the dataset on which to perform search. Concretely the list of the «dynamic» POI.
  • searchParams attribute (see FindNearbyByRoadParams) which contains the parameters of the search:
- the parameters defining the search: the central point of the search (expressed as a geographic point), and the search mode, and the options of route computation,
- the parameters limiting the search: the number of POI required and the search area which is defined by the maximum search distance by road to locate POI and the maximum time it takes to reach the POI by road.
The «request» parameter of the method specifies the sort order (implicit order by default) of the result dataset. 

For that you must also specify the resultFormat attribute (see BasicFoundLocationListFormat) in the «request» parameter of the method (see FindNearbyInputPOIByRoadRequest structure).

 

Note: 

Two search modes are now available:

  • One mode (normal mode) allows to search the nearest «dynamic» Point of Interest (POI defined by an identifier a geographic position) which can be reached from the central point of the search.
  • The other mode (reverse mode) allows to search nearest «dynamic» Point of Interest (POI defined by an identifier a geographic position) allowing to reach the central point of the search.

Errors 

 Error code  Description  Possible problems
300 Invalid request parameter - request parameter value is not defined (null)
301 Invalid search dataset - search dataset is not valid (null)
- search dataset is not valid (empty)
- search dataset contains more that 30 dynamic POI.
302 Invalid search parameters - search parameters is null
- search center is null
- search center is defined with invalid geographic coordinates
- invalid itinerary option
- ...
304 Invalid result format - supplied order is not valid
- ...
305 Itinerary computation error - An error occurs during the itinerary computation
3 Abnormal service termination - internal problem

Code sample (Java) 

Will be available in a future version

Code sample (VB.NET)
Will be available in a future version

Code sample (C#.NET)
Will be available in a future version