xls:DetermineRouteRequest

Specifies the Determine Route request parameters.

Element information

Namespace: http://niem.gov/niem/external/ogc-openls/1.1.0/dhs-gmo/1.0.0

Schema document: external/ogc-openls/1.1.0/dhs-gmo/1.0.0/ols.xsd

Type: xls:DetermineRouteRequestType

Properties: Global, Qualified

Content

Sequence [1..1]
1. Choice [1..1]
  - xls:RouteHandle Reference to a proviously determined route stored at the Route Determination Service server.
  - xls:RoutePlan The criteria upon which a route is determined.
2. xls:RouteInstructionsRequest [0..1] Request parameters for turn-by-turn route directions and advisories formatted for presentation.
3. xls:RouteGeometryRequest [0..1] Request parameters for route geometry.
4. xls:RouteMapRequest [0..1] The request parameters for route maps.

Attributes

Name	Occ	Type	Description	Notes
provideRouteHandle	[0..1]	xsd:boolean	Requests the return of a route handle.	Default value is "false".
distanceUnit	[0..1]	xls:DistanceUnitType	Specifies the unit for measuring distance.	Default value is "M".

Used in

Type geo:DetermineRouteRequestType (Element geo:DetermineRouteRequest)

Substitution hierarchy

xls:_RequestParameters
- can be substituted with xls:DetermineRouteRequest

Sample instance

<xls:DetermineRouteRequest>
   <xls:RouteHandle routeID="string"/>
   <xls:RouteInstructionsRequest/>
   <xls:RouteGeometryRequest>
      <xls:BoundingBox>
         <gml:lowerCorner>1.0 1.0</gml:lowerCorner>
         <gml:upperCorner>1.0 1.0</gml:upperCorner>
      </xls:BoundingBox>
   </xls:RouteGeometryRequest>
   <xls:RouteMapRequest>
      <xls:Output>
         <xls:BBoxContext>...
         </xls:BBoxContext>
      </xls:Output>
   </xls:RouteMapRequest>
</xls:DetermineRouteRequest>