CalculateRoute

This method allows a route calculation between two addresses with optional intermediate addresses. The input of the addresses is done by normal address information or in a coordinate format.

Name Description Data Type
SystemPartner The name of the access partner; is generated by YellowMap and communicated to the partner. xml:string
SecurityID The access key; is generated by YellowMap and communicated to the partner. xml:string
Channel Any character string that is logged and used to identify the call later. It can be freely chosen. xml:string
CoordFormatOut The coordinate format to be returned for the determined address. One of the values from the list Coordinate Formats xml:string
IsoLocale The locale, composed of language and country; for example: de-DE for German in Germany. xml:string
CarType One of the valid speed profiles xml:string
RouteOptimization One of the values for the Route-Optimization xml:string
RouteMap Allows you to create a static map for route calculation. By default set to 'false'. xml:boolean
RouteTime

Decides about the evaluation of RouteTimeHour and RouteTimeMinute.
With 'START': Departure time
At 'END': arrival time

 xml:string
RouteTimeHour hour of departure/arrival time xml:unsignedInt
RouteTimeMinute Minute of departure/arrival time xml:unsignedInt
CoordFormatIn The coordinate format of the coordinate for which an address is to be determined. One of the values from the list Coordinate Formats xml:string
RouteStartLocX X-coordinate of the starting point of the route xml:string
RouteStartLocY Y-coordinate of the starting point of the route xml:string
RouteStartIsoCountryCode Country code of the country where the starting point of the route is located xml:string
RouteStartZip Zip code of the starting point of the route xml:string
RouteStartCity City in which the starting point of the route is located xml:string
RouteStartCityPart District in which the starting point of the route is located xml:string
RouteStartStreet Street, where the starting point of the route is located xml:string
RouteStartHouseNo House number where the starting point of the route is located xml:string
RouteEndLocX X-coordinate of the destination of the route xml:string
RouteEndLocY Y-coordinate of the destination of the route xml:string
RouteEndIsoCountryCode Country code of the country where the destination of the route is located xml:string
RouteEndZip Zip code of the destination of the route xml:string
RouteEndCity City in which the destination of the route is located xml:string
RouteEndCityPart District in which the destination of the route is located xml:string
RouteEndStreet

Street in which the destination of the route is located

 xml:string
RouteEndHouseNo House number where the destination of the route is located xml:string
RouteStation1LocX X-coordinate of waypoint 1 of the route xml:string
RouteStation1LocY Y-coordinate of waypoint 1 of the route xml:string
RouteStation1IsoCountryCode Country code of the country where the interim destination 1 of the route is located xml:string
RouteStation1Zip Zip code of interim destination 1 of the route xml:string
RouteStation1City City in which the interim destination 1 of the route is located xml:string
RouteStation1CityPart District in which the interim destination 1 of the route is located xml:string
RouteStation1Street Street in which the interim destination 1 of the route is located xml:string
RouteStation1HouseNo House number where the interim destination 1 of the route is located xml:string
RouteStation2LocX X-coordinate of waypoint 2 of the route xml:string
RouteStation2LocY Y-coordinate of the waypoint 2 of the route xml:string
RouteStation2IsoCountryCode Country code of the country where the intermediate destination 2 of the route is located xml:string
RouteStation2Zip Zip code of the interim destination 2 of the route xml:string
RouteStation2City City in which the interim destination 2 of the route is located xml:string
RouteStation2CityPart District in which the interim destination 2 of the route is located xml:string
RouteStation2Street Street in which the interim destination 2 of the route is located xml:string
RouteStation2HouseNo House number where the interim destination 2 of the route is located xml:string
RouteStation3LocX X-coordinate of waypoint 3 of the route xml:string
RouteStation3LocY Y-coordinate of the waypoint 3 of the route xml:string
RouteStation3IsoCountryCode Country code of the country where the intermediate destination 3 of the route is located xml:string
RouteStation3Zip Zip code of the interim destination 3 of the route xml:string
RouteStation3City City in which the interim destination 3 of the route is located xml:string
RouteStation3CityPart District in which the interim destination 3 of the route is located xml:string
RouteStation3Street Street in which the interim destination 3 of the route is located xml:string
RouteStation3HouseNo House number where the interim destination 3 of the route is located xml:string
Addition This parameter can be used to specify additional parameter values in the form of a query string. Format: Key1=Value1&Key2=Value xml:string

More information about the parameters can be found in the Parameter overview.