VIAMICHELIN SOAP API


Références Page 02


 POIId

Description

This Structure contains the elements whichdefine a unique POI identifier.

Use

This structure is sent as parameter to the getPoiInfo methods of the FindMichelinPOIand FindPOI ViaMichelin SOAP API. Thisstructure specifies the POI for which you want to obtain a complete description.

This structure is also present in thecomplete description of a POI (see attribute iddefined in the POI structure)

Attributes

Name (type)

Description

id
(String)

Contains a unique POI identifier for a POI database.

databaseId
(String)

Contains the POI database identifier.

language
(String)

Contains the language code used to translate the description fields of a POI.

Available values are:
  • fra: French
  • deu: German
  • spa: Spanish
  • ita: Italian
  • eng: English

 

 KeyValuePair

Description

This Structure defines a key-value pair.

Use

 

Attributes

Name (type)

Description

key
(String)

Contains the characters string which defined the type of information stored in the value attribute.

value
(String)

Contains the value associated with the key.

 

 NumericPair

Description

This Structure defines a key-value pair.                                                                     

Use

 

Attributes

Name (type)

Description

key
(integer)

Contains a numeric identifier.

value
(integer)

Contains the value associated with the key.

 

 AlphanumPair

Description

This Structure defines a key-value pair.

Use

 

Attributes

Name (type)

Description

key
(integer)

Contains a numeric identifier

value
(String)

Contains the value associated with the key.


 FindByKeywordsParams

Description

This Structure contains the specification of the search parameters for all the methods which allow POI to be found by keywords.

It specifies:
  • the keywords list,
  • the conditions to stop the POI search (number of expected results),
  • the country in which the POI search will be restricted.

Use

Used to specify the search parameters for all the methods which allow to find POI by keywords:

Attributes

Name (type)

Description

keywords(TextCriteriaDefinition)

Specifies thekeywords list and their interaction mode.

Required attribute (not null, not empty)

maxResult
(integer)

Contains the maximum results which should be returned by the POI search.

A valid value must be included between 1 and a boundary value depending on the type of POI (usually 50 is used). Any invalid value will be replaced by the nearest boundary value.

Required attribute

countryCode
(String)

Contains the ISO code (three characters) of the countryin which the POI search will be restricted.

Required attribute (not null, not empty, initialised with valid value)


 FindNearbyParams

Description

This Structure containsthe specification of the search parameters for all the methods which find POI located nearby a central point.

It specifies :
  • the search central point,
  • the conditions to stop the POI search :
  • the number of results expected,
  • the distance limit to reach the POI (the search radius).

Use

Used to specify the search parameters for all the methods which allow to find POI located nearby a central point:

Attributes

Name (type)

Description

searchCenter(GeoCoordinate)

Contains the search central point defined bygeographic coordinates (WGS84 encoded system).

Required attribute (not null, initialised with valid value)

maxResult
(integer)

Contains the maximum results which should be returned by the POI search.

A valid value must be between 1 and a boundary value depending on the type of POI (usually 50 is used). Any invalid value will be replaced by the nearest boundary value.

Required attribute

maxDistance
(integer)

Contains the maximum distance of the search radius (expressed in metres).

The maximum search distance is 200 000 metres. Beyond this limit, any value will be treated as equal to 200 000.

The minimum search distance is 1 000 metres. Under this limit, any value will be treated as equal to 1 000.

Required attribute

 

 FindNearbyByRoadParams (extends FindNearbyParams )

Description

This Structure contains the specification of the search parameters for all the methods which find by road the POI located nearby a central point.

It specifies:
  • the search central point,
  • the itinerary options,
  • the search mode,
  • the conditions to stop the POI search :
  • the number of results expected,
  • the distance limit to reach the POI (the search radius),
  • the time limit to reach the POI.

Use

Used to specify the search parameters for all methods of POI spatial search by road:

Attributes

Name (type)

Description

searchCenter
(GeoCoordinates)

Contains the search central point defined bygeographic coordinates (WGS84 encoded system).

Required attribute (not null, initialised with valid value)

maxResult
(integer)

Contains the maximum results which should be returned by the POI search.

A valid value must be included between 1 and a boundary value depending on the type of POI (usually 50 is used). Any invalid value will be replaced by the nearest boundary value.

Required attribute

maxDistance
(integer)

Contains the maximum distance of the search radius (expressed in metres).

The maximum search distance is 200 000 metres. Beyond this limit, any value will be treated as equal to 200 000.

The minimum search distance is 1 000 metres. Under this limit, any value will be treated as equal to 1 000.

Required attribute

maxDuration
(integer)

Contains the time limit to reach the POI (expressed in seconds).

The maximum time is 7200 seconds. Beyond this limit, any value will be treated as equal to 7200.

The minimum time is 60 seconds. Under this limit, any value will be treated as equal to 60.

Required attribute

itineraryOptions
(ItineraryOptions)

Specifies the options that influence the computation method of the route.

Required attribute (not null)

mode
(integer)

Specifies the direction in which the POI search should be performed.

Available values are :
  • 0: normal mode finds the closest POI which they can reach from the central point.
  • 1: reverse mode finds the closest POI to reach the search central point.

Required attribute

 RouteDefinition

Description

This structure contains the specification of a route. It specifies the list of stopover and the route computation options.

Use

This structure is used in the request sent to the functions which allow to find Michelin POI or "static POI" (client POI stored in Database on ViaMichelin Server) located near a route :

Attributes

Name (type)

Description

itinerarySteps
(Array of ItineraryStep )

Contains the departure point (first item in the array), the list of intermediate stages and the arrival point (last item in the array).

The minimum number of elements is fixed at 2 (a Departure point and an arrival point). If the table contains less than one element, a SOAP fault is returned.

This list can contain up to 10stopovers. Beyond this limita SOAP fault is returned.

Required attribute (not null, not empty)

itineraryOptions
(ItineraryOptions)

Specifies the options that influence the computation method of the route.

Required attribute (not null)


 FindNearRouteParams

Description

This Structure containsthe specification of the search parameters for all the methods which find POI located near a route.

It specifies:
  • the route definition,
  • the conditions to stop the POI search :
  • the number of results expected,
  • the distance limit to reach the POI from the route,
  • the time limit to reach the POI from the route.

Use

Used to specify the search parameters for all methods which find POI located near a route.
  • findNearRoute method of FindPOI ViaMichelin SOAP API (see FindPOINearRouteRequest structure)
  • findNearRoute method of FindMichelinPOI ViaMichelin SOAP API (see FindMichelinPOINearRouteRequest structure)

Attributes

Name (type)

Description

routeDefinition
(RouteDefinition)

Contains the definition of the route near which the POI search should be performed.

Required attribute (not null, initialised with valid value)

maxResult
(integer)

Contains the maximum results which should be returned by the POI search.

  • A valid value must be between 1 and a boundary value depending on the type of POI (usually 50 is used). Any invalid value will be replaced by the nearest boundary value.

Required attribute

maxDistance
(integer)

Contains the maximum distance of the search radius (expressed in metres).

  • The maximum search distance is 200 000 metres. Beyond this limit, any value will be treated as equal to 200 000.
  • The minimum search distance is 1 000 metres. Under this limit, any value will be treated as equal to 1 000.

Required attribute

maxDuration
(integer)

Contains the time limit to reach the POI (expressed in seconds).

  • The maximum time is 7200 seconds. Beyond this limit, any value will be treated as equal to 7200.
  • The minimum time is 60 seconds. Under this limit, any value will be treated as equal to 60.

Required attribute


 FindNearbyDailyServicesParams (extends FindNearbyParams )

Description

This Structure containsthe specification of the search parameters for the methods which find daily services located nearby a central point.

It specifies:
  • the search central point,
  • the conditions to stop the POI search :
  • the number of results expected,
  • the distance limit to reach the POI (the search radius),
  • the categories of daily services to find.

Use

Used to specify the search parameters for the methods which allow to find daily services located nearby a central point:

Attributes

Name (type)

Description

searchCenter
(GeoCoordinates)

Contains the search central point defined bygeographic coordinates (WGS84 encoded system).

Required attribute (not null, initialised with valid value)

maxResult
(integer)

Contains the maximum results which should be returned by the POI search.

  • A valid value must be included between 1 and a boundary value depending on the type of POI (usually 50 is used). Any invalid value will be replaced by the nearest boundary value.

Required attribute

maxDistance
(integer)

Contains the maximum distance of the search radius (expressed in metres).

  • The maximum search distance is 200 000 metres. Beyond this limit, any value will be treated as equal to 200 000.
  • The minimum search distance is 1 000 metres. Under this limit, any value will be treated as equal to 1 000.

Required attribute

categories
(array of String)

Contains the daily services categories in which the POI should be found.

This attribute defines the search data set.

This list can contain up to 15categories. Beyond this limit a SOAP fault is returned.

Required attribute (not null, not empty)


 FindRoadAlertParams

Description

This Structure contains the specification of the search parameters for the methods which find "road alert" located on map.

It specifies:
  • the definition of the map on which the POI search should be performed,
  • a date

Use

Used to specify the search parameters for the methods which allow to find "road alert" located on map :

Attributes

Name (type)

Description

mapDefinition
(InputMapDefinitionList)

Contains the definition of the map on which the "road alert" should be found.

Required attribute (not null, initialised with a valid map definition)

date
(Date)

Contains the date of the search.

It's used because the major road events, such as roadwork and road opening/closures, are defined with a validity period.

A valid value must be equal or later than the current date.

Required attribute (not null, initialised with a valid value)


 NumCriteria

Description

This Structurecontains the definition of a numeric criterion.

Use

This structure is defined/used in NumCriteriaDefinition structure.

Attributes

Name (type)

Description

id
(integer)

Contains the identifier of the numeric metadata on which the criterion should be applied.

Required attribute

value
(integer)

Contains the numeric value which should be compared with the value of the numeric metadata.

Required attribute

compop
(integer)

Contains the comparison operator.

Available values for POI search by road :
  • 0: "equals" operator

  • Available values for other POI search type :
  • 0: "equals" operator
  • 1: "not equals" operator

Required attribute


 NumCriteriaDefinition

Description

This Structurecontains the specification of a filter defined by a set of numeric criteria, which applies a filter on the result data set according to the values of the numeric metadata.

Use

Associated with some methods which allow to findMichelin POI or static POI (client POI stored in a Database on ViaMichelin Server), this structure is used to apply a filter on the result data set according to the values of the numeric metadata.

This filter capability is available in the following methods :
  • findNearbyPOI , findNearbyPOIByRoad , findNearRoute and  findByKeyword methods of FindPOI ViaMichelin SOAP API
  • findNearby , findNearbyByRoad , findNearRoute and findByKeyword methods of the FindMichelinPOI VIAMICHELIN SOAP API.

This structure is used in BasicSearchCriteria & SearchCriteria & MichelinPOISearchCriteria structure.

Attributes

Name (type)

Description

criteriaList
(Array of NumCriteria)

Contains the list of numeric criteria.

Required attribute

 

mode
(integer)

Contains the value which specifies the interaction between several numeric criteria.

Available values are:
  • 0 : POI search method begins to search for POI corresponding to all the numeric criteria. If the number of found POI is insufficient (equals 0), it completes the search with corresponding POI that in certain numeric criteria. If the number of found elements is still insufficient (equals 0), it completes the POI search without taking into account numeric criteria.
  • 1 : POI search method begins to search for POI corresponding to all the numeric criteria. If the number of found POI is insufficient (equals 0), it completes the search with corresponding POI that in certain numeric criteria.
  • 2 : POI search method search only for POI corresponding to all the numeric criteria.

Required attribute


 TextCriteriaDefinition

Description

This Structurecontains the specification of a filter defined by a set of textual criteria (keywords). This means that it allows to filter the result data set according to the POI name value, and for Michelin POI only, according to the content of alphanumeric fields

Use

Associated with some methods which allow to findMichelin POI or static POI (client POI stored in a Database on ViaMichelin Server), this structure is used to apply a filter on the result data set according to the content of alphanumeric fields.

This filter capability is available in the following methods :
  • findNearbyPOI method of FindPOI ViaMichelin SOAP API
  • findNearby method of the FindMichelinPOI VIAMICHELIN SOAP API.

  • This structure is also used in the search parameters of the methods which allow to find POI by keywords:
  • findByKeyword method of FindPOI ViaMichelin SOAP API
  • findByKeyword method of FindMichelinPOI ViaMichelin SOAP API

This structure is defined/used in SearchCriteria & MichelinPOISearchCriteria structure.

Attributes

Name (type)

Description

keywords
(String)

Contains the list of keywords separate by space character.

Required attribute

mode
(integer)

Contains the value which specifies the interaction between several keywords.

Available values are:
  • 0 : POI search method searches for POI which contain all the specifiedkeywords.
  • 1 : POI search method searches for POI which contain at least one of specifiedkeywords.

Required attribute

scope
(integer)

Contains the value which specifies the scope of the keywords search.

Available values for Michelin POI search are:
  • 0 : POI search method searches the keywords only in the name field.
  • 1 : POI search method searches the keywords in the name field and in all alphanumeric fields (descriptions & alphanumeric metadata)

  • Available values for static POI(client POI stored in a Database on ViaMichelin Server)search are:
  • 0 : POI search method searches the keywords only in the name field.

Required attribute


 BasicSearchCriteria

Description

This Structure contains the specification of a filter to apply in a POI search.

Use

Associated with some methods which allow to findMichelin POI or static POI (client POI stored in a Database on ViaMichelin Server), this structure is used to apply a filter on the result data set according to the values of the numeric metadata.

This filter capability is available in the following methods :
  • findNearbyPOIByRoad method of FindPOI ViaMichelin SOAP API
  • findNearRoute method of FindPOI ViaMichelin SOAP API
  • findByKeyword method of FindPOI ViaMichelin SOAP API
  • findNearbyByRoad method of the FindMichelinPOI VIAMICHELIN SOAP API
  • findNearRoute method of the FindMichelinPOI VIAMICHELIN SOAP API
  • findByKeyword method of the FindMichelinPOI VIAMICHELIN SOAP API

Attributes

Name (type)

Description

numCriteria(NumCriteriaDefinition)

Contains the specification of a filter defined by a set of numeric criteria, which applies a filter on the result data set according to the values of the numeric metadata.

Optional attribute


 SearchCriteria (extends BasicSearchCriteria )

Description

This Structure contains the specification of a filter to apply in a POI search.

Use

Associated with some methods which allow to findstatic POI (client POI stored in a Database on ViaMichelin Server), this structure is used to apply a filter on the result data set according to the values of the numeric metadata and/or according to the content of alphanumeric fields.

This filter capability is available in the following methods :
  • findNearbyPOI method of FindPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

numCriteria
(NumCriteriaDefinition)

Contains the specification of a filter defined by a set of numeric criteria, which applies a filter on the result data set according to the values of the numeric metadata.

Optional attribute

textCriteria
(TextCriteriaDefinition)

Contains the specification of a filter defined by a set of textual criteria (keywords). This means that it allows filtering the result data set according to the POI name or according to the alphanumeric fields? content.

Optional attribute


 MichelinPOISearchCriteria (extends SearchCriteria )

Description

This Structure contains the specification of a filter to apply in a POI search.

Use

Associated with some methods which allow findingMichelin POI, this structure is used to apply a filter on the result data set according to the values of the numeric metadata and/or according to the content of alphanumeric fields.

This filter capability is available in the following methods :
  • findNearby method of the FindMichelinPOI VIAMICHELIN SOAP API.

Attributes

Name (type)

Description

numCriteria
(NumCriteriaDefinition)

Contains the specification of a filter defined by a set of numeric criteria, which allow applying a filter on the result data set according to the values of the numeric metadata.

Optional attribute

textCriteria
(TextCriteriaDefinition)

Contains the specification of a filter defined by a set of textual criteria (keywords). This means that it allows filtering the result data set according to the POI name or according to the alphanumeric fields? content.

Optional attribute

restrictedSearch
(boolean)

Specifies if the POI search have to be restricted to the place where the search centre has been defined.


 BasicFoundLocationListFormat

Description

This Structure contains the specification to format a search result data set.

That allows specifying the sort order (implicit order by default) of the search result data set.

Use

This Structure is used to specify the sort order of the results which were obtained by a search of dynamic POI (POI defined by geographical co-ordinates) located nearby a central point.

These formatting capabilities are available in the following methods :

Attributes

Name (type)

Description

orderBy
(integer)

Allows specifying the sort order to apply on the list of found locations.

Available values are:
  • 0 : the found locations list will be sorted by "implicit order". This means that the items in the list will be sortedaccording to the order in which they will have been found.
  • 1 : the found locations list will be sorted by "distance".
  • 2 : the found locations list will be sorted by "duration".


 FoundLocationListFormat

Diagrams

 

Description

This Structurecontains the specification to format a search result data set.

That allows to specify :
  • the elements of the found location (all by default) which should be returned in the result structure,
  • the language (English by default) to which the POI descriptions should be returned,
  • the sort order (implicit order by default) of the search result data set.

Use

This Structure is used to specify the format of the result data set which was obtained by the search of Michelin POI or static POI (client POI stored in a Database on ViaMichelin Server).

These formatting capabilities are available in the following methods :

Attributes

Name (type)

Description

language
(String)

Contains the language code used to translate the description fields of a POI.

Available values are:
  • fra: French
  • deu: German
  • spa: Spanish
  • ita: Italian
  • eng: English

datasheetContent
(Array of String)

Contains the identifier list of the elements which should be returned in the datasheet of the POI.

If this attribute is null, all the available information of the POI datasheet will be returned.

If this attribute is empty, the POI datasheet will be empty.

Available elements identifier are :

 

"iconId":

The icon identifier linked to the POI

 
 

"TranslatedName":

The name of the POI in the language specified in the supplied request.

 
 

"level":

Contains the level of geocoding.

Available values are:
  • 1: city level
  • 2: Street level
  • 3: Street number level
  • 4: arbitrary level
 
 

"tel":

The main phone number associated with the POI.

 
 

"intlTel":

The main phone number associated with the POI in international format.

 
 

"tel2":

The secondary phone number associated with the POI.

 
 

"intlTel2":

The secondary phone number associated with the POI in international format.

 
 

"fax":

The fax number associated with the POI.

 
 

"intlFax":

The fax number associated with the POI in international format.

 
 

"email":

The email address associated with the POI.

 
 

"web":

The web site URL associated with the POI.

 
       

withAddress
(boolean)

Specifies if the address associated with found location should be returned in the response structure.

withAddressDetails
(boolean)

Specifies if the address details associated with found location should be returned in the response structure.

withMetanumList
(boolean)

Specifies if the numeric metadata associated with found location should be returned in the response structure.

withMetastringList
(boolean)

Specifies if the alphanumeric metadata associated with found location should be returned in the response structure.

withDescriptionList
(boolean)

Specifies if the descriptions associated with found location should be returned in the response structure.

withCategoryList
(boolean)

Specifies if the categories associated with found location should be returned in the response structure.

withPhotoList
(boolean)

Specifies if the photos/pictures associated with found location should be returned in the response structure.

orderBy
(integer)

Specifies the sort order to apply on the list of found locations.

Available values are:
  • 0 : the found locations list will be sorted by "implicit order". This means that the items in the list will be sortedaccording to the order in which they will have been found.
  • 1 : the found locations list will be sorted by "distance".
  • 2 : the found locations list will be sorted by "duration".
  • 3 : the found locations list will be sorted by "name".