VIAMICHELIN SOAP API


findNearbyInputPOI method

Description 

This method finds a list of «dynamic» Points of Interest (POI defined by an identifier a geographic position) located around a central point. 
Specifications 

  • The maximum search radius is 200 000 meters. Beyond this limit, any value will be treated as equal to 200 000.
  • The minimum search radius is 1 000 meters. Under this limit, any value will be treated as equal to 1 000.
  • The list of dynamic POI can contain up to 1000 items. Beyond this limit a SOAP fault is returned.

Input Parameters 

 Parameter  Mandatory  Description
request
(FindNearbyInputPOIRequest)
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, ...),
- 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 for 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 FindNearbyInputPOIRequest 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 FindNearbyParams) which contains the parameters of the search:
- the central point of the search (expressed as a geographic point),
- And the parameters allowing to limit the POI search (the number of POI required and the search radius).
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 FindNearbyInputPOIRequest structure).
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 1000 dynamic POI.
302 Invalid search parameters - search parameters is null
- search center is null
- search center is defined with invalid geographic coordinates
- ...
304 Invalid result format - supplied order is not valid
- ...
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