Corridor Search Request

Contents

Parameters

Below are request and response parameters that are unique to a Corridor Search. Refer to the Common Parameters page for information on request and response parameters common in all searches. Note: corridor searches do not support searching of Map Data (It's coming soon!)

Request Parameters

Name Description
sessionId
String		 Using our Directions Web Service, it is possible to use the session Id from a previous route, then do a corridor search along that route.

This is a required parameter if the line parameter is missing!
line
LineString		 The LineString of points to search along.

This is a required parameter is the sessionId parameter is missing!
width
Number		 The width of how far away from the corridor path to search.

default is 5.
bufferedWidth
Number		 The bufferedWidth is used if the maximum number of results has not been reached within the given width. It will then use the bufferedWidth to add to the width to try and get more results.

default is 0.25.

Response Parameters

Name Description JSON Example Return Value(s) XML Example Return Value(s)
sessionId The session to pull the route ribbon from (This is only returned is a sessionId was given). 
sessionId: "0ba1e4a3-8fdc-4e68-9349-33086b83b2ef"
 
<sessionId>0ba1e4a3-8fdc-4e68-9349-33086b83b2ef</sessionId>
line
LineString		 The LineString to generate the corridor from (This is only returned is a line was given). 

line: [
	40.078811,
	-76.730422,
	41.078811,
	-74.730422,
	40.078811,
	-74.730422,
	39.961879,
	-76.730422,
	39.961879,
	-76.730422,
}

          
<line>
	<latLng>
		<lat>40.078811</lat>
		<lng>-76.730422</lng>
	</latLng>
	<latLng>
		<lat>41.078811</lat>
		<lng>-74.730422</lng>
	</latLng>
	<latLng>
		<lat>40.078811</lat>
		<lng>-74.730422</lng>
	</latLng>
	<latLng>
		<lat>39.961879</lat>
		<lng>-76.730422</lng>
	</latLng>
	<latLng>
		<lat>39.961879</lat>
		<lng>-76.730422</lng>
	</latLng>    
</line>

 

Advanced Corridor Search Sample


Options Value(s)
Line:
Route Session Id:
Units:
Width:
Buffered Width:
Exact Links:
Max Matches:
Shape format:
Current Page:
Page Size:
Input Format:
Output Format:
Hosted Data:
Remote Data:

(Output will be displayed below)


  © MapQuest, Inc. All rights reserved.    Privacy Policy | Terms of Use