VIAMICHELIN SOAP API


References Guide 04

 

 ItineraryResult

Description

This structure contains the description of a calculated route.

Use

This structure is used to store the result of the methods which calculate a route:

  • getRouteNonMotorized method of RouteCalculation ViaMichelin SOAP API
  • getRoute method of RouteCalculation ViaMichelin SOAP API

Attributes

Name (type)

Description

itinerarySummary
( ItinerarySummary )

It contains the route summary. It brings together the global informations to the route.

itineraryItems
(array of ItineraryItem )

It contains the detail of the route: the sorted list of the driving instructions composing the roadmap (each element of the list corresponding to a line in this roadmap).

Note: Theses informations are provided only if they were asked in the request (see ResponseOptions

itineraryTrace
( ItineraryTrace )

Contains the binary description of graphic representation of the calculated route.

Note: This information is provided only if it was asked in the request (see ResponseOptions )


 ItineraryStep

Description

This structure defines a stopover to reach.

Use

This structure is used by the methods which allows to calculate a route like the following:

  • getRoute method of RouteCalculation ViaMichelin SOAP API (see ItineraryRequest )
  • getRouteNonMotorized method of RouteCalculation ViaMichelin SOAP API (see NonMotorizedItineraryRequest )
  • This structure is used also by the methods which allows to find POI near a route:

  • findNearRoute method of FindPOI ViaMichelin SOAP API (see routeDefinition attribute defined in FindNearRouteParams structure)
  • findNearRoute method of FindMichelinPOI ViaMichelin Web Services (see routeDefinition attribute defined in FindNearRouteParams structure)

Attributes

Name (type)

Description

name
(String)

Contains the stopover identifier.

Optional attribute

location(LocationDefinition)

Contains the definition of the location corresponding to the stopover.

Required attribute (not null)

passingCloseTo
(boolean)

Specifies if a stage must be regarded as a stopover or a point close to which the route must pass.
(for future use)


 ItineraryPreferences

Description

This Structure contains the specification of the options that will influence the computation method of the itinerary.

Use

This structure is defined/used in ItineraryOptions structure.

Attributes

Name (type)

Description

favourMotorways
(boolean)

Specifies if the route should favour motorways.

avoidCrossingBorders
(boolean)

Specifies if the route should avoid crossing borders.

avoidTolls
(boolean)

Specifies if the route should avoid tolls.

avoidRoadTaxAreas
(boolean)

Specifies if the route should avoid road tax areas.

avoidOffroadConnections
(boolean)

Specifies if the route should avoid off-road connections (ferries, trains...)


 BasicItineraryOptions

Description

This Structure contains the specification of the options that will influence the computation method of the routeson foot or by bike.

Use

This structure is defined/used in NonMotorizedItineraryRequest structure.

Attributes

Name (type)

Description

date
(Date)

Specifies the departure date of the route.

It is used because the computation method of the routes takes into account the major events scheduled in France, such as roadwork and road opening/closures.

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

Required attribute (not null, initialised with valid value)

vehicleType
(integer)

Specifies the type of "vehicle" used to calculate the itinerary.

Available values are:
  • 2: foot
  • 3: bike

Required attribute


ItineraryOptions (extends BasicItineraryOptions )

Description

This Structure contains the specification of the options that will influence the computation method of the routes for the search POI method.

Use

Used in the parameters/requests sent to the set of functionality which allow to find POI by road:

  • findNearbyPOIByRoad method of FindPOI ViaMichelin SOAP API (see FindNearbyByRoadParams structure)
  • findNearbyInputPOIByRoad method of FindPOI ViaMichelin SOAP API (see FindNearbyByRoadParams structure)
  • findNearbyByRoad method of FindMichelinPOI ViaMichelin SOAP API (see FindNearbyByRoadParams structure)
  • Used in the parameters/requests sent to the set of functionality which allow to find POI near route:

  • findNearRoute method of FindPOI ViaMichelin SOAP API (see routeDefinition attribute defined in FindNearRouteParams structure)
  • findNearRoute method of FindMichelinPOI ViaMichelin SOAP API (see routeDefinition attribute defined in FindNearRouteParams structure)

Attributes

Name (type)

Description

date
(Date)

Specifies the departure date of the route.

It's used because the computation method of the routes takes into account the major events scheduled in France, such as roadwork and road opening/closures.

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

Required attribute (not null, initialised with valid value)

vehicleType
(integer)

Specifies the type of vehicle used to calculate the itinerary.

 For example, with truck vehicle the calculation favours the motorway and decreases the speed average.

Available values are:
  • 0: Light vehicle
  • 1: truck

Required attribute

itineraryType
(integer)

Specifies the type of itinerary to be calculated.

Available values for the set of functionality which allow to find POI:

  • 0: recommended (The "recommended" route type focuses on road safety and comfort while offering a good compromise between time and distance).
  • 1: fastest (The " fastest " route type provides the fastest route by emphasising motorways and major roads).2: shortest (optimises distance).
  • 2: shortest (optimises distance)

Required attribute

preferences
( ItineraryPreferences )

Contains complementary options which allow specifying avoidance.

Optional attribute


 ExtendedItineraryOptions (extends ItineraryOptions )

Description

This Structure contains the specification of the options that will influence the computation method of the routesby "light vehicle" or by truck.

Use

This structure is defined/used in ItineraryRequest structure.

Attributes

Name (type)

Description

date
(Date)

Specifies the departure date of the route.

It's used because the computation method of the routes takes into account the major events scheduled in France, such as roadwork and road opening/closures.

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

Required attribute (not null, initialised with valid value)

vehicleType
(integer)

Specifies the type of vehicle used by the itinerary calculation.

For example, with truck vehicle the calculation favours the motorway and decreases the speed average.

Available values are:

  • 0: Light vehicle
  • 1: truck

Required attribute

itineraryType
(integer)

Specifies the type of itinerary to be calculated.

Available values for the functionality which allow to compute a route:

  • 0: recommended (The "recommended" route type focuses on road safety and comfort while offering a good compromise between time and distance).
  • 1: fastest (The "fastest" route type provides the fastest route by emphasising motorways and major roads).
  • 2: shortest (optimises distance)
  • 3: economic (The "economical" route type takes into consideration fuel consumption costs and tolls as well as the route distance).

Required attribute

preferences
( ItineraryPreferences )

Contains complementary options which allow specifying avoidance.

Optional attribute

fuelCost
( Cost )

Defines the fuel cost expressed in Euro (EUR).

Optional attribute

fuelConsumption
(array of double)

Defines the consumption of the vehicle.

If this attribute is specify (not null), it must be a array with three elements :
  • first element corresponds to the average consumption (expressed in litre) at 50 km/h.
  • second element corresponds to the average consumption (expressed in litre) at 90 km/h.
  • third element corresponds to the average consumption (expressed in litre) at 120 km/h.

This attributes allows computing the fuel cost associated with a route, and have an impact on the computation of the economic routes.

Optional attribute

 PresentationOptions

Description

This structure contains the parameters tohave an influence upon the presentation style of a calculated routeon foot or by bike.

Use

This structure is defined/used in NonMotorizedItineraryRequest structure.

Attributes

Name (type)

Description

detailLevel
(integer)

Allows specifying the display detail level of the calculated route.

Available values are:
  • 0: Synthetic Level (calculated route contains only the itinerary summary, not the itinerary block/segment list).
  • 1: Normal Level.

Required attribute

language
(String)

Contains the language code of the itinerary.

Available values are:
  • fra: French
  • deu: German
  • spa: Spanish
  • ita: Italian
  • eng: English
  • nld: Dutch
  • por: Portuguese
  • dan: Danish
  • fin: Finnish
  • swe: Swedish
  • nor: Norwegian

Required attribute (not null)

instructionsFormat (integer)

Contains the formatting mode of the route instructions.

Available values are:
  • 0: HTML
  • 1: ASCII

Required attribute

 ExtendedPresentationOptions (extends PresentationOptions )

Description

This structure contains the parameters tohave an influence upon the presentation style of a calculated routeby "light vehicle" or by truck.

Use

This structure is defined/used in ItineraryRequest structure.

Attributes

Name (type)

Description

 

detailLevel
(integer)

Allows specifying the display detail level of the calculated route.

Available values are:
  • 0: Synthetic Level (calculated route contains only the itinerary summary, not the itinerary block/segment list).
  • 1: Normal Level.

Required attribute

 

language
(String)

Contains the language code of the itinerary.

Available values are:

  • fra: French
  • deu: German
  • spa: Spanish
  • ita: Italian
  • eng: English
  • nld: Dutch
  • por: Portuguese
  • dan: Danish
  • fin: Finnish
  • swe: Swedish
  • nor: Norwegian

Required attribute (not null)

 

instructionsFormat (integer)

Contains the formatting mode of the route instructions.

Available values are:
  • 0: HTML
  • 1: ASCII

Required attribute

 

tollCategory
(integer)

Contains the category used to return the toll cost.

Available values are:
  • 1: car category
  • 2: motorcycle category
  • 3: caravan category
  • 4: truck with 2 axles category
  • 5: truck with 3 axles category
  • 6: truck with 4 axles category
  • 7: truck with 5 axles category

Required attribute

 

 ResponseOptions

Description

This structure defines the elements which must be produced by a route calculation.

Use

This structure is defined/used in ItineraryRequest & NonMotorizedItineraryRequest structures.

Attributes

Name (type)

Description

responseElements
(integer)

Allows specifying the route elements to be produced.

Available values are:
  • 1: only the graphic route representation (Itinerary trace).
  • 2: only calculated route description (Itinerary road map).
  • 3: the graphic route representation (Itinerary trace) and the calculated route description (Itinerary road map).

Required attribute

mapDefinitionCalculated
(integer)

Allows specifying the map definition to be computed.

Available values are:
  • 0: compute and return no map definition.
  • 1: compute and return map definition to visualise full itinerary on a map. This value is taken into account only when the itinerary trace is computed.
  • 2: compute and return map definition of itinerary blocs (only some itinerary block types are associated with a map definition).This value is taken into account only when the itinerary trace is computed.
  • 3: compute and return map definition of itinerary blocs (only some itinerary block type are associated with a map definition) and the map definition to visualise full itinerary on a map. This value is taken into account only when the itinerary trace is computed.

Required attribute

mainMapSize  (ImgSize )

Contains the size (expressed in pixels) of the map which allows visualising full itinerary.

This attribute is taken into account only if the main map definition has been computed.

The maximum map width is 900 pixels for Europe and 600 pixels for the other territories. Beyond this limit, the boundary value is used.

The minimum map width is 50 pixels. Under this limit, the value 50 is used.

The maximum map height is 900 pixels for Europe and 600 pixels for the other territories. Beyond this limit, the boundary value is used.

The minimum map height is 50 pixels. Under this limit, the value 50 is used.

Optional attribute

blocMapSize
( ImgSize )

Contains the size (expressed in pixels) of the map which allows visualising a bloc/segment of the route.

This attribute is taking into account only if the map definitions of the bloc/segment of the route have been computed.

The maximum map width is 200 pixels. Beyond this limit, the value 200 is used.

The minimum map width is 50 pixels. Under this limit, the value 50 is used.

The maximum map height is 200 pixels. Beyond this limit, the value 200 is used.

The minimum map height is 50 pixels. Under this limit, the value 50 is used.

Optional attribute

 

 ItineraryRequest

Description

This structure contains the necessary parameters to compute a route by "light vehicle" or by truck.

Use

This structure allows to define the request used by the method whichcompute a route by "light vehicle" or by truck:

  • getRoute method of RouteCalculation ViaMichelin SOAP API

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
( ExtendedItineraryOptions )

Allows specifying the options that influence the computation method of the route.

Required attribute (not null)

presentationOptions ( ExtendedPresentationOptions )

Contains the options to have an influence upon the presentation style of a calculated route.

Required attribute (not null)

responseOptions
( ResponseOptions )

Allows you to specify which elements must be produced by the route calculation.

Required attribute (not null)

 

 NonMotorizedItineraryRequest

Description

This structure containsthe necessary parameters to compute a route on foot or by bike.

Use

This structure allows to define the request used by the method whichcompute a route on foot or by bike:

  • getRouteNonMotorized method of RouteCalculation ViaMichelin SOAP API

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
( BasicItineraryOptions )

Allows specifying the options that influence the computation method of the route.

Required attribute (not null)

presentationOptions ( PresentationOptions )

Contains the options to have an influence upon the presentation style of a calculated route.

Required attribute (not null)

responseOptions
( ResponseOptions )

Allows you to specify which elements must be produced by the route calculation.

Required attribute (not null)

 DecodeItitraceRequest

Description

This structure contains the necessary parameters to decode a graphic representation of a calculated route.

Use

This structure allows to define the request used by the method whichdecode a graphic representation of a calculated route:

  • decodeItiTrace method of RouteCalculation ViaMichelin SOAP API

Attributes

Name (type)

Description

distance
(integer)

Contains the minimum distance between two points (expressed in metres), and allows to reduce the number of points returning.

e.g. : If the distance equals zero, the method returns all the points which represent the route.

e.g. : If the distance equals 100, the method returns one point at best every 100 metres.

The maximum number of points returned is 20000. Beyond this limit, a SOAP fault is returned.

Required attribute

itiTrace
(ItineraryTrace)

Contains the graphic representation of a calculated route which has to be decoded.

To obtain a valid graphic representation of a calculated route, you must call the getRoute or the getRouteNonMotorized methods of the RouteCalculation ViaMichelin SOAP API.

Required attribute (not null)

 FindNearbyInputPOIRequest

Description

This Structure specify the search request used tofind dynamic POI(POI defined by geographical co-ordinates)located nearby a central point.

Use

Allows to define the search request used bythe methods which allow to find dynamic POI(POI defined by geographical co-ordinates)located nearby a central point:
  • findNearbyInputPOI method of FindPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

searchDataset
(array of InputPOI )

Contains the specification of the data set on which to perform search. In this case, a list of geographic coordinates.

Required attribute (not null)

searchParams
( FindNearbyParams )

Contains the specification of the search parameters.

Required attribute (not null)

resultFormat
( BasicFoundLocationListFormat )

Contains the specification of the format of the search result data set.

Specifies the sort order (implicit order by default) of the search result data set.

Optional attribute

 FindNearbyPOIByRoadRequest

Description

This Structure specifies the search request used tofind by road the static POI(client POI stored in a Database on ViaMichelin Server)located nearby a central point.

Use

Allows to define the search request used bythe methods which allow to find by road the static POI(client POI stored in a Database on ViaMichelin Server)located nearby a central point:
  • findNearbyPOIByRoad method of FindPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

searchDataset
(String)

Contains the specification of the data set on which to perform search. In this case, a POI database identifier.

Required attribute (not null)

searchParams
(FindNearbyByRoadParams)

Contains the specification of the search parameters.

Required attribute (not null)

searchFilter
BasicSearchCriteria )

Contains the specification of the filter to apply on the search result data set.

Optional attribute

resultFormat
FoundLocationListFormat)

Contains the specification of the format of the search result data set.

That allows to specify the items list of the found location (all by default) which should be returned, the language (English by default) to which they should be returned and the sort order (implicit order by default) of the search result data set.

Optional attribute


 FindNearbyPOIByRoadRequest

Description

This Structure specifies the search request used tofind by road the static POI(client POI stored in a Database on ViaMichelin Server)located nearby a central point.

Use

Allows to define the search request used bythe methods which allow to find by road the static POI(client POI stored in a Database on ViaMichelin Server)located nearby a central point:
  • findNearbyPOIByRoad method of FindPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

searchDataset
(String)

Contains the specification of the data set on which to perform search. In this case, a POI database identifier.

Required attribute (not null)

searchParams
FindNearbyByRoadParams )

Contains the specification of the search parameters.

Required attribute (not null)

searchFilter
( BasicSearchCriteria )

Contains the specification of the filter to apply on the search result data set.

Optional attribute

resultFormat
( FoundLocationListFormat )

Contains the specification of the format of the search result data set.

That allows to specify the items list of the found location (all by default) which should be returned, the language (English by default) to which they should be returned and the sort order (implicit order by default) of the search result data set.

Optional attribute

 

 FindNearbyInputPOIByRoadRequest

Description

This Structure specifies the search request used tofind by road the static POI(client POI stored in a Database on ViaMichelin Server)located nearby a central point.

Use

Allows to define the search request used bythe methods which allow to find by road the static POI(client POI stored in a Database on ViaMichelin Server)located nearby a central point:
  • findNearbyPOIByRoad method of FindPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

searchDataset
(String)

Contains the specification of the data set on which to perform search. In this case, a POI database identifier.

Required attribute (not null)

searchParams
FindNearbyByRoadParams )

Contains the specification of the search parameters.

Required attribute (not null)

searchFilter
( BasicSearchCriteria )

Contains the specification of the filter to apply on the search result data set.

Optional attribute

resultFormat
( FoundLocationListFormat )

Contains the specification of the format of the search result data set.

That allows to specify the items list of the found location (all by default) which should be returned, the language (English by default) to which they should be returned and the sort order (implicit order by default) of the search result data set.

Optional attribute

 FindNearRouteRequest

Description

This Structure specifies the search request used tofind static POI(client POI stored in a Database on ViaMichelin Server)located near a route.

Use

Allows to define the search request used bythe methods which allow to find static POI(client POI stored in a Database on ViaMichelin Server)located near a route:
  • findNearRoute method of FindPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

searchDataset
(String)

Contains the specification of the data set on which to perform search. In this case, a POI database identifier.

Required attribute (not null)

searchParams
FindNearRouteParams )

Contains the specification of the search parameters.

Required attribute (not null)

searchFilter
( BasicSearchCriteria )

Contains the specification of the filter to apply on the search result data set.

Optional attribute

resultFormat
FoundLocationListFormat )

Contains the specification of the format of the search result data set.

That allows to specify the items list of the found location (all by default) which should be returned, the language (English by default) to which they should be returned and the sort order (implicit order by default) of the search result data set.

Optional attribute

 FindDailyServicesRequest

Description

This Structure specifies the search request used tofind "daily services" located nearby a central point.

Use

Allows to define the search request used bythe methods which allow to find "daily services"located nearby a central point:
  • findDailyServices method of FindPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

searchDataset
(String)

Contains the specification of the data set on which to perform search. In this case, a POI database identifier.

Required attribute (not null)

searchParams
FindNearbyDailyServicesParams )

Contains the specification of the search parameters.

Required attribute (not null)

resultFormat
( FoundLocationListFormat )

Contains the specification of the format of the search result data set.

That allows to specify the items list of the found location (all by default) which should be returned, the language (English by default) to which they should be returned and the sort order (implicit order by default) of the search result data set.

Optional attribute

 FindNearbyMichelinPOIByRoadRequest

Description

This Structure specifies the search request used tofind by road the Michelin POI located nearby a central point.

Use

Allows to define the search request used bythe methods which allow to find by road the Michelin POI located nearby a central point:
  • findNearbyByRoad method of FindMichelinPOI ViaMichelin SOAP API

Attributes

Name (type)

Description

searchDataset
(String)

Contains the specification of the data set on which to perform search. In this case, a POI database identifier.

Required attribute (not null)

searchParams
FindNearbyByRoadParams )

Contains the specification of the search parameters.

Required attribute (not null)

searchFilter
( BasicSearchCriteria )

Contains the specification of the filter to apply on the search result data set.

Optional attribute

resultFormat
( FoundLocationListFormat )

Contains the specification of the format of the search result data set.

That allows to specify the items list of the found location (all by default) which should be returned, the language (English by default) to which they should be returned and the sort order (implicit order by default) of the search result data set.

Optional attribute