Description

This Structure defines the coordinates of a pixel on a map image.

Attributes

x
(integer)

The pixel offset from the upper-left corner of an image along the horizontal axis.

y
(integer)

The pixel offset from the upper-left corner of an image along the vertical axis.

Description

This Structure defines a geographic point in longitude and latitude values.

The geographic coordinates are encoded in WGS84.

Attributes

longitude
(double)

Contains the longitude value of the geographic point (a decimal degree in WGS84 encoded system).

latitude
(double)

Contains the latitude value of the geographic point (a decimal degree in WGS84 encoded system).

Description

This Structure contains a rectangle definition where the corner positions are expressed in geographic coordinates (in WGS84 encoded system).

Attributes

southEastPoint
( GeoCoordinates )

Contains the geographic coordinates of the south-east point.

northWestPoint
( GeoCoordinates )

Contains the geographic coordinates of the north-west point.

Description

This Structure contains a rectangle definition where the corner positions are expressed in pixels.

Attributes

lowerRightPoint
( PixelPoint )

Contains the pixel coordinates of the lower-right point.

upperLeftPoint
( PixelPoint )

Contains the pixel coordinates of the upper-left point.

Description

This Structure contains a cost definition.

Attributes

currency
(String)

Contains the currency in which the price is expressed.

price
(double)

Contains a price value.

Description

This Structure allows defines the size in pixels of an image.

Attributes

width
(integer)

Contains the width in pixels of the image (picture/icon/map)

height
(integer)

Contains the height in pixels of the image (picture/icon/map)

Description

This Structure defines any type of location (city/place, POI, geographic coordinates).

Use

This structure is used in many request parameters to define a specific location.

In the case there is a conflict between any of these properties, the geographic property has priority, then the location unique identifier and finally the POI identifier.

Attributes

geoCoordinates
( GeoCoordinates )

Contains the geographic coordinates (in WGS84 encoded system) of a location.

locationID
(String)

Contains the unique identifier of a location. This information can represent either address or a city, and it can be obtained from Geocoding or ReverseGeocoding ViaMichelin Web Services.

poiID
( POIId )

Contains the unique identifier of a Michelin POI or of a "static POI" (client POI stored in Database on ViaMichelin Server). It can be obtained from one of the search POI methods defined in FindPOI or FindMichelinPOI ViaMichelin Web Services.

Description

This structure contains a set of the map definitions.

Use

• pixelsToXY method defined in MapManagement Web Services (see mapDefinition attribute defined in PixelsToXYRequest structure)
• xyToPixels method defined in MapManagement Web Services (see mapDefinition attribute defined in XYToPixelsRequest structure)
• findRoadAlert method defined in FindPOI Web Services (see mapDefinition attribute defined in FindRoadAlertParams structure)

Attributes

byID
( MapDefinitionByID )

Contains the map definition defined by a unique map identifier.

Optional attribute

byScale
( MapDefinitionByScale )

Contains the map definition defined by a central point and a scale.

Optional attribute

Description

This Structure contains the specification of an address to geocode.

Use

Used in the GeocodingRequest structure to define an address to geocode.

Attributes

address
(String)

Contains an address (defined by street number and/or street name) or landmark.

This attribute must be initialised with a valid value (not null and a value different from empty string) if any valid value are defined for cityName attribute and for postalCode attribute.

cityName
(String)

Contains the city label.

This attribute must be initialised with a valid value (not null and a value different from empty string) if any valid value are defined for address attribute and for postalCode attribute.

postalCode
(String)

Contains a postal code.

This attribute must be initialised with a valid value (not null and a value different from empty string) if any valid value are defined for cityName attribute and for address attribute.

stateName
(String)

Contains an administrative area denomination.

countryCode
(String)

Contains the ISO country code.

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

Description

This Structure defines the addresses list to geocode and the geocoding method which should be used.

Use

Sent as main parameter to the getLocationsList method of the Geocoding ViaMichelin Web Services, this structure specifies the addresses list to geocode and the the geocoding method which should be used.

Attributes

addressesList
(Array of InputAddress )

Contains an array of InputAddress , which define the addresses list to geocode.

This list can contain up to 50 addresses. Beyond this limit a SOAP fault is returned.

Required attribute (not null & not empty)

mode
(integer)

Allows specifying the geocoding mode to use.

• - 0 : "Classic" geocoding mode.
• - 1 : "Extended" geocoding mode. This mode is especially suitable for mobile devices, because it allows to geocode "input addresses" defined with a reduced number of characters. In fact,when a characters string will exceeds the first three characters, the application will consider the remaining characters as if they are "Wildcards". (e.g. geocoding of the input address "Welli, Westm, GBR" returns all the addresses having in his street label a word starting by "Welli" and in his city label a word starting by "West" like "Wellington Close, Westminster" and "Duke Of Wellington Place, Westminster" ...)

Required attribute

Description

This structure defines the list of geographical coordinates for which you want to obtain the associated segments of road.

Use

Sent as main parameter to the getLocationsList method of the ReverseGeocoding ViaMichelin Web Services, this structure specifies the geographical coordinates for which you want to obtain the associated segments of road.

Attributes

geoCoordinatesList
(Array of GeoCoordinates )

Contains the list of geographic coordinates used to search locations.

This list can contain up to 200 geographic coordinates. Beyond this limita SOAP fault is returned.

Required attribute (not null, not empty)

Description

This structure contains the departure point and a set of arrival points for which you want to obtain the distance (as the crow flies) separating them.

Use

Sent as main parameter to the getDistances method of the DistanceCalculation ViaMichelin Web Services, thisstructure specifies the departure point and a set of arrival points for which you want to obtain the distance (as the crow flies) separating them.

Attributes

departurePoint
( GeoCoordinates )

Contains the geographic coordinates (in WGS84 encoded system) of the departure point.

Required attribute (not null, initialised with valid coordinates)

arrivalPoints
(Array of GeoCoordinates )

Contains the list of geographic coordinates (in WGS84 encoded system) of arrival points.

This list can contain up to 1000 geographic coordinates. Beyond this limita SOAP fault is returned.

Required attribute (not null, not empty)

Description

This Structure contains the description of all locations/POIs matching search criteria as well as information about the search (search status & number of found elements)

Use

This structure is used to store the results list corresponding to a POI search, a geocoding or a reverse-geocoding.

Attributes

searchStatus
(integer)

Contains the status flag of the search.

• 0: One or more locations or POIs have been found.
• 1: No location/POI found as no known location corresponds to the search request.
• 2: No location/POI found as supplied geographic coordinates are invalid. (This occurs when the "geographic coordinates" in supplied reverseGeocoding request is null or invalid)
• 3: No location/POI found as supplied address is invalid (This occurs when the "input address" in supplied geocoding request is null).
• 4: No location found as some required fields of input address are missing. (This occurs when an insufficient number of attributes is specified in the "input address" in supplied geocoding request).
• 5: No location found as supplied country value in input address is invalid. (This occurs when supplied countryCode field value of input address is null or equal to empty string or equal to unsupported country code).
• 8: search not computed, item out of bound. (This occurs when the number of input address in supplied geocoding request or the number of geographic coordinates in supplied reverse geocoding request exceed the defined limits).
• 9: No location found as an unexpected error occurs (the treatment will not be taken into account).
• 10: No location found as the supplied scale is not valid (findRoadAlert only)

size
(integer)

Contains the number of locations/POIS found matching a location search or a POI search.

foundLocations
(Array of FoundLocation )

Contains a range of FoundLocation , which defines the list of locations/POIs corresponding to the search.

Description

This Structure contains the complete description of a found location/POI as well as information about the accuracy of this result relative to the search.

Use

This structure is defined/used in FoundLocationList structure.

Attributes

distance
(integer)

Contains the distance from the search centre or from the route.

duration
(integer)

Contains the duration from the search centre or from the route.

locationDesc
( Location )

Contains the complete description of the location/POI found.

Description

This Structure contains the complete description of a found location/POI

Use

This structure is defined/used in FoundLocation structure.

Attributes

id
(String)

Contains a unique identifier of found location (It is initialised with null value for a POI search).

type
(integer)

Contains the found location type.

Available values are:

• 0: if the location describes a city level address (a city or a place).
• 1: if the location describes an administrative area (region, state, country...) ( For future use )
• 2: if the location describes a POI.
• 3: if the location describes a street level address.

geoCoordinates
( GeoCoordinates )

Contains the geographic coordinates (in WGS84 encoded system) of the found location.

address
( Address )

Contains the address description.

poi
( POI )

Contains the POI description.

Description

This Structure contains the complete address description of a found location/POI

Use

This structure is defined/used in Location structure.

Attributes

coherenceDegree
( CoherenceDegreeInfo )

Contains the coherent level of the found result compared the supplied request.

formattedCityLine
(String)

Contains the correctly formatted value of the city address line (e.g.: "Westminster SW1X 9PY").

It can be initialised with "null" value.

formattedStreetLine
(String)

Contains the correctly formatted value of the street address line.

It can be initialised with "null" value.

details
( AddressDetails )

Contains more detailed information of address description.

Description

This Structure contains the coherent level of the found result compared the supplied request.

This information is only significant after an invocation of "Geocoding" or "ReverseGeocoding" Web Services.

Use

This structure is defined/used in Address structure.

Attributes

streetCoherence(integer)

Contains the coherent level of the found result compared to the street fields values of the supplied request.

Available values are:

• 0 : For "Geocoding" Web Services, this means that all supplied fields are used to find the result. For "ReverseGeocoding" Web Service, this means that the service has found a road segment.
• 1 : For "Geocoding" Web Services, this means that the street number is an approximation - the nearest known number is selected (e.g. geocoding of the input address "260 rue de Rivoli, Paris" returns the geographic coordinates of "258 rue de Rivoli, Paris")
• 2 : For "Geocoding" Web Services, this means that the supplied street number is unknown - this street number is ignored and a point in the street is selected (e.g. geocoding of the input address "20 rue de la paix, Neufchateau" returns the geographic coordinates of a point in the street "rue de la paix" in Neufchateau)
• 3 : For "Geocoding" Web Services, this means that the supplied street name is unknown – this street name is ignored and the town centre is selected (e.g. geocoding of the input address "Unknown street, London" returns the geographic coordinates of "London centre"). For ReverseGeocoding Web Service, this means that the service has not found a road segment but a city/place.

cityCoherence
(integer)

Contains the coherent level of the found result compared to the city fields values of the supplied request.

Available values are:

• 0: For "Geocoding" Web Services, this means that all supplied fields are used to find the result.
• 1: For "Geocoding" Web Services, this means that some supplied fields values are not coherent, therefore all supplied data are not taken into account (e.g. geocoding of the input address "Paris, 92150" ignores the city label and returns the geographic coordinates of "Suresnes, 92150").

Description

This Structure contains the detailed address information of a found location/POI

Use

This structure is defined/used in Address structure.

Attributes

streetNumber
(String)

Contains the street number associated with the address.

It can be initialised with "null" value if no street number is associated with the found location.

streetLabel
(String)

Contains the street denomination associated with the address.

It can be initialised with "null" value if no street denomination is associated with the found location (the location describes a town or a place).

district
(String)

Contains the district denomination associated with the address (e.g.: "Paris 01").

It can be initialised with "null" value if no district is associated with the found location.

city
(String)

Contains the city denomination associated with the address.

gathering
(String)

Contains the gathering denomination associated with the address (e.g.: "La Défense";"Bruxelles Métropole").

It can be initialised with "null" value if no gathering is associated with the found location.

state
(String)

Contains the major administrative area denomination (region, state ...) associated with the address (e.g.: "Hauts de Seine"; "Schleswig-Holstein"; "Westminster"; "Tennessee").

It can be initialised with "null" value if no administrative area is associated with the found location.

zipCode
(String)

Contains the postcode associated with the address (e.g.: "92150"; "SW1X 9PY").

countryCode
(String)

Contains the ISO country code associated with the address (e.g.: "DEU"; "USA"; "GBR").

officialCountryCode
(String)

Contains the official country code associated with the address (e.g.: "D" for Germany).

countryLabel
(String)

Contains the country denomination associated with the address (e.g.: "Deutschland"; "United States").

Diagrams

Description

This Structure contains the complete description of a POI.

Use

This structure is defined/used in Location structure.

Attributes

id
( POIId )

Contains a structure which defines a unique POI identifier.

name
(String)

Contains the name of the POI.

datasheet
(Array of KeyValuePair )

Contains a set of information/data items associated with the POI in the form of a list of key-value pair.

In the key-value pair, the key is a characters string which defines the type of the information/data stored in the value.

The list content is defined in the supplied request.

Available values for the key and associated information:

"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.

• 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.

metanumList
(Array of NumericPair )

Contains the list of numeric metadata associated with the POI in the form of a list of key-value pair.

Thislist which stores up to 50 pairs. The meaning of each value is defined by the client and depends on themetadata identifier and onthe type of the POI.

In the key-value pair, the key is an integer which defines the numeric metadata identifier. And the value is an integer which contains the value associated to this numeric metadata.

metastringList
(Array of AlphanumPair )

Contains the list of alphanumeric metadata associated with the POI in the form of a list of key-value pair.

Thislist which stores up to 15 pairs. The contents and the meaning of each value are defined by the client and depend on the metadata identifierand on the type of the POI.

In the key-value pair, the key is an integer which defines the alpha-numeric metadata identifier. The value is a characters string which contains the value associated to this alpha-numeric metadata.

descriptionList
(Array of AlphanumPair )

Contains the list of descriptions associated with the POI in the form of a list of key-value pair.

Thislist which stores up to 30 pairs. The contents and the meaning of each are defined by the client and depend on themetadata identifier (e.g. metadata 1 stores different information that metadata 2) andon the type of the POI.

In the key-value pair, the key is an integer which defines the description identifier. The value is a characters string which contains the value associated to this description.

photoList
(Array of String)

Contains a list of URL of the pictures/photos associated with the POI.

categoryList
(Array of String)

Contains the list of category codes to which belongs the POI.

Description

This Structure contains the elements whichdefine a unique POI identifier.

Use

This structure is sent as parameter to the getPoiInfo methods of the FindMichelinPOI and FindPOI ViaMichelin Web Services. 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 id defined 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.

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

Description

This Structure defines a key-value pair.

Use

Attributes

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.

Description

This Structure defines a key-value pair.

Use

Attributes

key
(integer)

Contains a numeric identifier.

value
(integer)

Contains the value associated with the key.

Description

This Structure defines a key-value pair.

Use

Attributes

key
(integer)

Contains a numeric identifier

value
(String)

Contains the value associated with the key.

Description

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

• 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

• findByKeyword method of FindPOI ViaMichelin Web Services (see FindByKeywordRequest )
• findByKeyword method of FindMichelinPOI ViaMichelin Web Services (see FindByKeywordRequest )

Attributes

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)

Description

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

• 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

• findNearbyPOI method of FindPOI ViaMichelin Web Services (see FindNearbyPOIRequest )
• findNearbyInputPOI method of FindPOI ViaMichelin Web Services (see FindNearbyInputPOIRequest )
• findNearby method of FindMichelinPOI ViaMichelin Web Services (see FindNearbyMichelinPOIRequest )

Attributes

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 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

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.

• 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

• findNearbyPOIByRoad method of FindPOI ViaMichelin Web Services (see FindNearbyPOIByRoadRequest structure)
• findNearbyInputPOIByRoad method of FindPOI ViaMichelin Web Services (see FindNearbyInputPOIByRoadRequest structure)
• findNearbyByRoad method of FindMichelinPOI ViaMichelin Web Services (see FindNearbyMichelinPOIByRoadRequest structure)

Attributes

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.

• 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

Description

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

Use

• findNearRoute method of FindPOI ViaMichelin Web Services (see FindNearRouteParams structure)
• findNearRoute method of FindMichelinPOI ViaMichelin Web Services (see FindNearRouteParams structure)

Attributes

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)

Description

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

• 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

• findNearRoute method of FindPOI ViaMichelin Web Services (see FindPOINearRouteRequest structure)
• findNearRoute method of FindMichelinPOI ViaMichelin Web Services (see FindMichelinPOINearRouteRequest structure)

Attributes

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

Description

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

• 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

• findDailyServices method of FindPOI ViaMichelin Web Services Services (see FindDailyServicesRequest structure)

Attributes

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)

Description

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

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

Use

• findRoadAlert method of FindPOI ViaMichelin Web Services (see FindRoadAlertRequest structure)

Attributes

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)

Description

This Structurecontains the definition of a numeric criterion.

Use

This structure is defined/used in NumCriteriaDefinition structure.

Attributes

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.

• 0: "equals" operator

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

Required attribute

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.

• findNearbyPOI , findNearbyPOIByRoad , findNearRoute and  findByKeyword methods of FindPOI ViaMichelin Web Services
• findNearby , findNearbyByRoad , findNearRoute and findByKeyword methods of the FindMichelinPOI ViaMichelin Web services.

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

Attributes

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.

• 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

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.

• findNearbyPOI method of FindPOI ViaMichelin Web Services
• findNearby method of the FindMichelinPOI ViaMichelin Web services.

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

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

Attributes

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.

• 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.

• 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

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.

• findNearbyPOIByRoad method of FindPOI ViaMichelin Web Services
• findNearRoute method of FindPOI ViaMichelin Web Services
• findByKeyword method of FindPOI ViaMichelin Web Services
• findNearbyByRoad method of the FindMichelinPOI ViaMichelin Web services
• findNearRoute method of the FindMichelinPOI ViaMichelin Web services
• findByKeyword method of the FindMichelinPOI ViaMichelin Web services

Attributes

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

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.

• findNearbyPOI method of FindPOI ViaMichelin Web Services

Attributes

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

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.

• findNearby method of the FindMichelinPOI ViaMichelin Web services.

Attributes

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.

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.

• findNearbyInputPOI method of FindPOI ViaMichelin Web Services (see FindNearbyInputPOIRequest ),
• findNearbyInputPOIByRoad method of FindPOI ViaMichelin Web Services (see FindNearbyInputPOIByRoadRequest ).

Attributes

orderBy
(integer)

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

• 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".

Diagrams

Description

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

• 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).

• findByKeyword method of FindPOI ViaMichelin Web Services (see FindByKeywordRequest ),
• findDailyServices method of FindPOI ViaMichelin Web Services (see FindDailyServicesRequest ),
• findNearbyPOI method of FindPOI ViaMichelin Web Services (see FindNearbyPOIRequest ),
• findNearbyPOIByRoad method of FindPOI ViaMichelin Web Services (see findNearbyPOIByRoad ),
• findNearRoute method of FindPOI ViaMichelin Web Services (see FindNearRouteRequest ).

Attributes

language
(String)

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

• 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.

• 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.

• 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".

Description

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

• the language (English by default) to which the POI descriptions should be returned.

Use

This Structure is used to specify the format (language of descriptions fields)of the result data set which was obtained by the search of"road alert" located on map.

• findRoadAlert method of FindPOI ViaMichelin Web Services (see FindDailyServicesRequest structure).

Attributes

language
(String)

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

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

Description

This Structure contains the search request to use withthe methods which allow finding POI by keywords.

Use

Allows to define the search request used bythe methods which allow to find POI by keywords :

• findByKeyword method of FindPOI ViaMichelin Web Services
• findByKeyword method of FindMichelinPOI ViaMichelin Web Services

Attributes

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

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 elements 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

Description

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

Use

• findNearbyPOI method of FindPOI ViaMichelin Web Services

Attributes

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

Contains the specification of the search parameters.

Required attribute (not null)

searchFilter
( SearchCriteria )

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

Description

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

Use

• findNearby method of FindMichelinPOI ViaMichelin Web Services

Attributes

searchDataset
(String)

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

Required attribute (not null)

searchParams
( FindNearbyParams )

Contains the specification of the search parameters.

Required attribute (not null)

searchFilter
( MichelinPOISearchCriteria )

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

Description

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

Use

• findNearbyInputPOI method of FindPOI ViaMichelin Web Services

Attributes

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

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

• findNearbyPOIByRoad method of FindPOI ViaMichelin Web Services

Attributes

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

Description

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

Use

• findNearbyByRoad method of FindMichelinPOI ViaMichelin Web Services

Attributes

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

Description

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

Use

• findNearbyInputPOIByRoad method of FindPOI ViaMichelin Web Services

Attributes

searchDataset
(array of InputPOI 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
( FindNearbyByRoadParams )

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

Description

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

Use

• findDailyServices method of FindPOI ViaMichelin Web Services

Attributes

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

Description

This Structure specifies the search request used tofind "road alert" located on map.

Use

• findRoadAlert method of FindPOI ViaMichelin Web Services

Attributes

searchDataset
(Array of String)

Contains the specification of the data set on which to perform search. In this case, a list of road alert type.

• " SPEED_CAMERA ": Gets the speed camera.
• " ROAD_EVENT " : Gets the road eventsuch as roadwork and road opening/closures.

Required attribute (not null, not empty)

searchParams
( FindRoadAlertParams )

Contains the specification of the search parameters.

Required attribute (not null)

resultFormat
( RoadAlertListFormat )

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

That allows to specify the language (English by default) to which the POI descriptions should be returned.

Optional attribute

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

• findNearRoute method of FindPOI ViaMichelin Web Services

Attributes

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

Description

This Structure specifies the search request used tofind Michelin POI located in a specific located near a route.

Use

• findNearRoute method of FindMichelinPOI ViaMichelin Web Services

Attributes

searchDataset
(String)

Contains the specification of the data set on which to perform search. In this case, a Michelin 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

Description

This Structure specifies the request used to count the number ofMichelin POI located in a city/place.

Use

• getDetailingCount method of FindMichelinPOI ViaMichelin Web Services

Attributes

searchDataset
(String)

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

Required attribute (not null)

locationId
(String)

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

Description

This structure is abstract and defines a common interface for all map definition.

Attributes

mapSize
( ImgSize )

Contains the width and the height (expressed in pixels) of the map which should be generate.

The maximum map width is 900 pixels for Europe and 600 pixels for the other territories.

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.

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

Required attribute (not null)

Description

This structure contains the attributes which defines a map by a unique identifier.

Use

This structure is used to specify the necessary parameters to generate a map from an unique map identifier (see MapByIdRequest structure).

This structure is returned in the structure which represents a generated map (see mapDefinitions attribute defined in GeneratedMap ).

This structure is returned in the structure which represents the best map definition found (see MapDefinitionList ).

Attributes

mapSize
( ImgSize )

Contains the width and the height (expressed in pixels) of the map which should be generate.

The maximum map width is 900 pixels for Europe and 600 pixels for the other territories.

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.

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

Required attribute (not null)

mapId
(String)

Contains unique map identifier.

Required attribute (not null)

Description

This structure contains the attributes which defines a map by a central point and a scale.

Use

This structure is used to specify the necessary parameters to generate a map from a central point and a scale(see MapByScaleRequest structure).

This structure is returned in the structure which represents a generated map (see mapDefinitions attribute defined in GeneratedMap ).

This structure is returned in the structure which represents the best map definition found (see MapDefinitionList ).

Attributes

mapSize
( ImgSize )

Contains the width and the height (expressed in pixels) of the map which should be generate.

The maximum map width is 900 pixels for Europe and 600 pixels for the other territories.

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.

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

Required attribute (not null)

centerPoint
( GeoCoordinates )

Contains the geographic coordinates of the central point of the map.

Required attribute (not null)

pixelSize
(double)

Defines the scale of the map. (i.e. one pixel on the map is equal to "pixelSize" metres on the ground).

Required attribute

Description

This structure contains the attributes which defines a map by a rectangle.

Use

This structure is returned in the structure which represents a generated map (see mapDefinitions attribute defined in GeneratedMap ).

This structure is returned in the structure which represents the best map definition found (see MapDefinitionList ).

Attributes

mapSize
( ImgSize )

Contains the width and the height (expressed in pixels) of the map which should be generate.

The maximum map width is 900 pixels for Europe and 600 pixels for the other territories.

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.

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

Required attribute (not null)

boundingRectangle
( GeoRectangle )

Contains the definition of the rectangle bordering the map.

Required attribute (not null)

Description

This Structure contains the description of a generated map.

Use

This structure is the result of the getBestMapDefinition method defined in MapManagement ViaMichelin Web Services.

This structure is defined/used in GeneratedMap structure.

Attributes

byID
( MapDefinitionByID )

Contains the map definition defined by a unique map identifier.

byScale
( MapDefinitionByScale )

Contains the map definition defined by a central point and a scale.

byRectangle
( MapDefinitionByRect )

Contains the map definition defined by a rectangle.

Description

This Structure contains the description of a generated map.

Use

This structure is defined/used in GeneratedMap structure.

Attributes

id
(integer)

Contains the supplied identifier of a pin-Logo.

position
( PixelPoint )

Contains the position (expressed in pixels) corresponding to the pin-Logo linked with identifier.

hotArea
( PixelRectangle )

Contains the hot area definition (expressed in pixels) corresponding to the pin-Logo linked with identifier.

Description

This Structure contains the description of a generated map.

Use

This structure is the result of themethod which allow to generate a map :

• getMapByID method defined in MapManagement ViaMichelin Web Services,
• getMapByScale method defined in MapManagement ViaMichelin Web Services,
• getBestMap method defined in MapManagement ViaMichelin Web Services.

Attributes

mapDefinitions
( MapDefinitionList )

Contains the map definition list corresponding to the generated map.

Note: This information can be reused to generate a new map.

url
(String)

Contains the URL to access to the generated map.

copyright
(String)

Contains the textual version of the copyright which must be associated with the generated map.

pinLogoInfo
(Array of PinLogoInfo )

Contains the information about each pin-Logo supplied (visible or not on the map).

Description

This structure contains the specification of the actions to be realised on a map.

Use

This structure is defined/used in MapOptions structure.

Attributes

type
(integer)

Contains the type of action to be realised.

• 0: Horizontal shifting
• 1: Vertical shifting
• 2: Zoom in
• 3: Zoom out

Required attribute

value
(integer)

Contains the value associated with the action type:

• With horizontal shifting action, value contains a shifting factor. A shifting factor under zero specifies a west shifting, otherwise an east shifting.
• With vertical shifting action, value contains a shifting factor. A shifting factor under zero specifies a south shifting, otherwise a north shifting.
• With zoom in and zoom out actions, value will not be taken into account.

Required attribute

Description

This structure is abstract and defines the attributes which all the requests of map generation have in common.

Use

This structure is defined/used in MapRequest , MapByIdRequest , MapByScaleRequest , BestMapRequest structures.

Attributes

imgFormat
(integer)

Contains the picture format to generate.

• 0: GIF normal palette.
• 1: GIF reduce palette (Use this option to obtain maps to show on mobiles or PDA).

Note: the choice of the picture format affects the number of scale available.

Required attribute

actionsOnMap
(array of MapAction )

Contains a list of actions that will be realised on a map.

This list can contain up to 5 mapactions. Beyond this limitevery supplied map action is ignored.

Note: Some platforms (Pocket PC, Smart Phone, platforms using compact .Net framework...) do not support arrays whose value is null. They throw exceptions during serialisation/deserialisation of null arrays. This can be avoided by using empty arrays instead of null arrays.

Optional attribute

withCopyright
(boolean)

Specifies if the copyright associated with the generated map should be displayed on the map.

Required attribute

Description

This structure contains the definition of the picture which will be associated with thepin-logo.

Use

This structure is defined/used in PinLogo structure.

Attributes

name
(String)

Contains the name of the picture/icon file to associate with a pin-logo (name without file extension).

Required attribute

size
( ImgSize )

Contains the width and the height in pixels of the picture/icon of the pin-logo.

This attribute is used to compute the interactive zone associated with the pin-logo.

The maximum icon width is 50 pixels. Beyond this limit, the value 50 is used.

The maximum icon height is 50 pixels. Beyond this limit, the value 50 is used.

Required attribute

Description

This structure contains the definition of the graphic element which represents a geographic point (location, POI ...) on a map.

Use

This structure is defined/used in GraphicItems structure.

Attributes

id
(integer)

Contains the pin-logo identifier.

This attribute is used to make the connection between pin-logo and hot area.

Required attribute

pixelpos
( PixelPoint )

Contains the pixel coordinates of the position where the pin-logo should be drawn.

Optional attribute

geopos
( GeoCoordinates )

Contains the geographic coordinates(in WGS84 encoded system)of the position where the pin-logo should be drawn.

Optional attribute

displayMode
(integer)

Defines the graphic representation mode of the pin-logo.

• 0: a point below an identifier, below a logo.
• 1: a point below a logo.
• 2: a logo.

Required attribute

icon
( IconDef )

Contains the definition of the picture which should be associated with thepin-logo.

Required attribute

returnHotArea
(Boolean)

Allows specifying if an interactive zone associated with the pin-logo must be returned.

Required attribute

Description

This structure contains the definition of the graphic element which represents on a map a graphic representation of a route defined by a list of pixels coordinates or a list of geographic coordinates.

Use

This structure is defined/used in GraphicItems structure.

Attributes

pixelPointList
(array of PixelPoint )

Contains the positions (expressed in pixels coordinates) of the points which define the graphic representation of a route.

Optional attribute

geoCoordinatesList
(array of GeoCoordinates )

Contains the positions (expressed in geographic coordinates) of the points which define the graphic representation of a route.

Optional attribute

color
(String)

Contains the colour of thegraphic representation of a route.

The colour is specified by an RGB value (red, green, and blue), expressed with six digits in hexadecimal format.

Required attribute

thickness
(integer)

Contains the thickness(expressed in pixels)of thegraphic representation of a route.

Required attribute

Description

This structure contains the list of graphic elements to draw on the map.

Use

This structure is defined/used in MapRequest , MapByIdRequest , MapByScaleRequest , BestMapRequest structures.

Attributes

pinLogos
(Array of PinLogo )

Contains the list of the pin-logo to draw on the map.

This list can contain up to 100pin-logos. Beyond this limit aSOAP fault is returned.

Note: Some platforms (Pocket PC, Smart Phone, platforms using compact .Net framework...) do not support arrays whose value is null. They throw exceptions during serialisation/deserialisation of null arrays. This can be avoided by using empty arrays instead of null arrays.

Optional attribute

itineraryTrace
( ItineraryTrace )

Contains the binary description of graphic representation of the calculated route to be displayed on the map.

Note: to obtain a valid graphic representation of a calculated route, you must invoke the RouteCalculation ViaMichelin Web Service.

Optional attribute

inputTraceList
(array of InputTrace )

Contains a set of graphic route representation which are defined by a list of pixels coordinates or a list of geographic coordinates.

The sum of the points used to define the set of input trace can not exceed 300.Beyond this limit aSOAP fault is returned.

Optional attribute

Description

This structure is abstract and defines the attributes which all the requests of map generation have in common.

Use

Attributes

options
( MapOptions )

Contains the parameters to specify the format of the generated map, as well as the list of the actions to be performed on map before generation.

Required attribute (not null)

graphicItems
( GraphicItems )

Contains the specification of the graphic items/elements which should be drawn on the generated map.

Optional attribute

Description

This structure contains the necessary parameters to generate a map from a unique map identifier.

Use

• getMapByID method of MapManagement ViaMichelin Web Services

Attributes

mapDefinition
( MapDefinitionByID )

Contains the map definition to be used to generate the map.

Required attribute (not null)

options
( MapOptions )

Contains the parameters to specify the format of the generated map, as well as the list of the actions to be performed on map before generation.

Required attribute (not null)

graphicItems
( GraphicItems )

Contains the specification of the graphic items/elements which should be drawn on the generated map.

Optional attribute

Description

This structure contains the necessary parameters to generate a map from a central point and a scale.

Use

• getMapByScale method of MapManagement ViaMichelin Web Services

Attributes

mapDefinition
( MapDefinitionByScale )

Contains the map definition to be used to generate the map.

Required attribute (not null)

options
( MapOptions )

Contains the parameters to specify the format of the generated map, as well as the list of the actions to be performed on map before generation.

Required attribute (not null)

graphicItems
( GraphicItems )

Contains the specification of the graphic items/elements which should be drawn on the generated map.

Optional attribute

Description

This structure contains the necessary parameters to generate a map from a list of specific locations.

Use

• getBestMap method of MapManagement ViaMichelin Web Services

Attributes

mapSize
( ImgSize )

Contains the width and the height (expressed in pixels) of the map which should be generate.

The maximum map width is 900 pixels for Europe and 600 pixels for the other territories.

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.

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

Required attribute (not null)

locations
(Array of LocationDefinition )

Contains the locations list which should be displayed on the generated map.

Required attribute (not null)

options
( MapOptions )

Contains the parameters to specify the format of the generated map, as well as the list of the actions to be performed on map before generation.

Required attribute (not null)

graphicItems
( GraphicItems )

Contains the specification of the graphic items/elements which should be drawn on the generated map.

Optional attribute

Description

This structure contains the necessary parameters to compute the best map definition which displays a list of specific locations.

Use

• getBestMapDefinition method of MapManagement ViaMichelin Web Services

Attributes

mapSize
( ImgSize )

Contains the width and the height (expressed in pixels) of the map which should be generate.

The maximum map width is 900 pixels for Europe and 600 pixels for the other territories.

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.

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

Required attribute (not null)

imgFormat
(integer)

Contains the picture format to generate.

Note: the choice of the picture format affects the number of scale available.

Required attribute

locations
(Array of LocationDefinition )

Contains the locations list which should be displayed on the generated map.

Required attribute (not null)

Description

This structure contains the necessary parameters to convert geographic positions into pixels positions.

Use

• xyToPixels method of MapManagement ViaMichelin Web Services

Attributes

geoCoordinatesList
(array of GeoCoordinates )

Contains the list of geographic coordinates (WGS84) to convert into corresponding Pixel positions on a given map.

This list can contain up to 1000 geographic coordinates. Beyond this limita SOAP fault is returned.

This list can contain less than one geographic coordinates. Under this limita SOAP fault is returned.

Required attribute (not null, not empty)

mapDefinition
( InputMapDefinitionList )

Contains the definition of the map from which the conversion must be applied.

Required attribute

Description

This structure contains the necessary parameters to convert pixels positions into geographic positions.

Use

• pixelsToXY method of MapManagement ViaMichelin Web Services

Attributes

pixelsList
(array of PixelPoint )

Contains the list of pixel positions on a given map to convert into corresponding geographic coordinates (WGS84).

This list can contain up to 1000 pixel positions. Beyond this limita SOAP fault is returned.

This list can contain less than one pixel positions. Under this limita SOAP fault is returned.

Required attribute (not null, not empty)

mapDefinition
( InputMapDefinitionList )

Contains the definition of the map from which the conversion must be applied.

Required attribute

Description

This structure contains the descriptionof an itinerary stopover really used to compute the route.

Use

This structure is defined/used in ItinerarySummary structure.

Attributes

name
(String)

Contains the supplied stopover identifier.

id
(String)

Contains a unique identifier of found location (It is initialised with null value for a POI search).

type
(integer)

Contains the found location type.

• 0: if the location describes a city level address (a city or a place).
• 1: if the location describes an administrative area (region, state, country...) ( For future use )
• 2: if the location describes a POI.
• 3: if the location describes a street level address.

geoCoordinates
( GeoCoordinates )

Contains the geographic coordinates (in WGS84 encoded system) of the found location.

address
( Address )

Contains the address description.

POI
(poi)

Contains the POI description.

Description

This structure contains the route summary.

Use

This structure is defined/used in ItineraryResult structure.

Attributes

itinerarySteps
(Array of ItineraryStepLocation )

Contains the list of the itinerary stopover description really used to compute the route.

tripDuration
(integer)

Contains the itinerary total trip/travel time in seconds.

tripDistance
(integer)

Contains the itinerary total trip/travel distance in metres.

drivingDuration
(integer)

Contains the itinerary total driving time in seconds.

drivingDistance
(integer)

Contains the itinerary total driving distance in metres.

drivingDurationOnMotorway
(integer)

Contains the itinerary total driving time on motorway/highway in seconds.

drivingDistanceOnMotorway
(integer)

Contains the itinerary total driving distance on motorway/highway in metres.

fuelCost
( Cost )

Contains the estimated amount of the cost (in Euro) of the fuel consumed on the route.

tollCost
(Array of Cost )

Contains the list of tolls amount grouped by currency for the category of vehicle supplied in the route calculation request.

Note: The array is empty when there is no toll.

roadTaxAreasCost
(Array of Cost )

Contains the total amount of the costs ofroad tax areas.

messages
(Array of String)

Contains the global messages associated to the route.

mainMapDefinition
( MapDefinitionList )

Contains the best map definition to display the entire itinerary trace on a map.

Note: This information is available only if its production was specified in the route calculation request (see mapDefinitionCalculated attributed defined in ResponseOptions structure)

Description

This structurecontains the information related to a part of the route (the driving instructions corresponding to a line in the roadmap).

Use

This structure is defined/used in ItineraryResult structure.

Attributes

geoCoordinates
( GeoCoordinates )

Contains the geographic coordinates (WGS84) of the starting point of this part of route.

duration
(integer)

Contains the duration on this part of route.

distance
(integer)

Contains the distance covered on this part of route.

partialTripDuration
(integer)

Contains the time since the departure to reach this part of route.

partialDrivingDistance
(integer)

Contains the distance since the departure to reach this part of route.

gatheringID
(integer)

Contains the identifier of the gathering to which this part of route belongs.

Each gathering contains a level 1 driving instruction and the list of related secondary driving instructions.

level
(integer)

Contains the level of the driving instructions

• 1: main driving instruction
• 2: secondary driving instruction (details) which contain the instructions and information related to a level one driving instruction.

instructions
(String)

Contains the driving instructions in the format supplied in the route calculation request (see instructionsFormat attribute defined in ExtendedPresentationOptions and PresentationOptions structures)

picto
(String)

Contains the name of the pictogram related to the driving instruction.

mapDefinition
( MapDefinitionList )

Contains the best map definition to display a part of the itinerary trace related to the driving instruction.

This information is available only for the driving instructions of level 1 and if its production was specified in the route calculation request (see mapDefinitionCalculated attributed defined in ResponseOptions structure)

Description

This structure contains a binary descriptionof a part of the graphic representation of a calculated route.

Use

This structure is defined/used in ItineraryTrace & SimpleItineraryTrace structures.

Attributes

part
(array of byte)

Contains an array of binary corresponding to the binary description of a part of the graphic representation of the calculated route.

Description

This structure contains the binary description of graphic representation of the calculated route.

Use

This structure is defined/used in ItineraryResult structure.

Attributes

binaryDesc
(array of ItineraryTracePart )

Contains an array of ItineraryTracePart corresponding to the binary description of each part of the graphic representation of the calculated route.

Description

This structure contains a list of geographic coordinates under a compact format.

Use

This structure is used to store the result of the decodeItiTrace method of RouteCalculation ViaMichelin Web Services.

To optimise the size of the SOAP response, the list of geographic points returned by the decodeItiTrace method is encoded in an array of byte.

So, to obtain the list of geographic coordinates you must parse this binary object. Each point is stored on 16 bytes:  8 bytes to store the longitude (IEEE 754 floating-point "double format" bit layout) + 8 bytes to store the latitude (IEEE 754 floating-point "double format" bit layout).

Attributes

binaryDesc
(array of ItineraryTracePart )

Contains a list of geographic coordinates under a compact format.

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 Web Services
• getRoute method of RouteCalculation ViaMichelin Web Services

Attributes

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 )

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 Web Services (see ItineraryRequest )
• getRouteNonMotorized method of RouteCalculation ViaMichelin Web Services (see NonMotorizedItineraryRequest )

This structure is used also by the methods which allows to find POI near a route:

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

Attributes

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)

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

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...)

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

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.

• 2: foot
• 3: bike

Required attribute

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 Web Services (see FindNearbyByRoadParams structure)
• findNearbyInputPOIByRoad method of FindPOI ViaMichelin Web Services (see FindNearbyByRoadParams structure)
• findNearbyByRoad method of FindMichelinPOI ViaMichelin Web Services (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 Web Services (see routeDefinition attribute defined in FindNearRouteParams structure)
• findNearRoute method of FindMichelinPOI ViaMichelin Web Services (see routeDefinition attribute defined in FindNearRouteParams structure)

Attributes

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.

• 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

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

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.

• 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

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

detailLevel
(integer)

Allows specifying the display detail level of the calculated route.

• 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.

• 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.

• 0: HTML
• 1: ASCII

Required attribute

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

detailLevel
(integer)

Allows specifying the display detail level of the calculated route.

• 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.

• 0: HTML
• 1: ASCII

Required attribute

tollCategory
(integer)

Contains the category used to return the toll cost.

• 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

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

responseElements
(integer)

Allows specifying the route elements to be produced.

• 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.

• 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

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 Web Services

Attributes

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)

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 Web Services

Attributes

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)

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 Web Services

Attributes

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 Web Services.

Required attribute (not null)