Directions - main

Spectrum OnDemand Web Services (SOAP)

Product type
Software
Portfolio
Verify
Product family
Product
Spectrum OnDemand
Version
main
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (SOAP)
First publish date
2006
Table 1. Get Travel Directions Direction Options

Parameter

Description

ShowDistance

Specifies whether to return the distance for the route.

Y
Yes, return the distance for the route. Default.
N
No, do not return the distance for the route.

ReturnRouteDirections

Specifies whether to return turn-by-turn directions for the route. This option is enabled by default.

Y
Yes, return textual turn-by-turn directions. Default.
N
No, do not return textual turn-by-turn directions.

ReturnSegmentGeometry

Specifies whether to return a set of latitude/longitude points that represent a geometry for a segment within a route. The segment geometry is used to create the route geometry. The output of this field is shown within the RouteDirections output field. For more information about route geometry, see What is Route Geometry?.

ReturnRouteGeometry

Specifies whether to return a set of latitude/longitude points that represent a route geometry. The route geometry can be used to create a route map and to perform analysis on the route.

One of the following:

All
Return all points in the route geometry.
End
Return just the end points of each route segment geometry.
None
Do not return route geometry. Default.

DefaultLanguage

Specifies the language in which GetTravelDirections should return directions.

One of the following:

sq
Return directions in Albanian.
zh_CN
Return directions in Chinese.
zh_TW
Return directions in Chinese (Taiwan).
hr
Return directions in Croatian.
cs
Return directions in Czech.
da
Return directions in Danish.
nl
Return directions in Dutch.
en
Return directions in English. Default
en-US
Return directions in American English.
et
Return directions in Estonian.
fi
Return directions in Finnish.
fr
Return directions in French.
de
Return directions in German.
hu
Return directions in Hungarian.
it
Return directions in Italian.
ja
Return directions in Japanese.
lv
Return directions in Latvian.
lt
Return directions in Lithuanian.
no
Return directions in Norwegian.
pt
Return directions in Portuguese.
ro
Return directions in Romanian.
sk
Return directions in Slovak.
sl
Return directions in Slovenian.
es
Return directions in Spanish.
sv
Return directions in Swedish.
ru
Return directions in Russian.
tr
Return directions in Turkish.

ShowTime

Specifies whether GetTravelDirections should return the time it takes to follow a direction within the route.

Y
Yes, return the time for the route. Default.
N
No, do not return the time for the route.

ShowPrimaryNameOnly

Specifies whether GetTravelDirections should return all names for a given street in the directions or if it should return just the primary name for a street.

Y
Yes, return just the primary name.
N
Return all names for a street. Default.

What is Route Geometry?

A route geometry is a series of latitude/longitude points that form a route. A route geometry can be as simple as a single point, such as a route that starts and ends on the same street segment:

Since the starting point is always known the route geometry in this very simple example could be just the end point. So if A is the starting point, the route geometry could be the latitude/longitude of point B.

In a more complex route geometry involving multiple route segments there can be several points in the route geometry. Consider the route highlighted below which starts at point A and ends at point C, traveling through intersections X, Y, and B:

In this route, the full route geometry would consist of the latitude/longitude of points A, X, Y, B, and C. Note that you can control which points to actually return and may choose to include all points in the route geometry or just the end points of each route segment. In the above example, the end points are B and C, since A to B is one route segment and B to C is another.