Polygon Search Request

Contents

Parameters

Below are request and response parameters that are unique to a Poylgon Search. Refer to the Common Parameters page for information on request and response parameters common in all searches.

Request Parameters

Name Description
polygon
Polygon
A string of points to make up a polygon. The first and the last point should match to complete the polygonal shape.

This is a required parameter!
locations
Location[]
Using this parameter you can input addresses or IP addresses to form a polygon shape. Same rule applies as above, the first and last locations must match.

This is a required parameter if polygon is not supplies!

Response Parameters

Name Description JSON Example Return Value(s) XML Example Return Value(s)
polygon
Polygon
This is the polygon to search (This is only returned is a polygon was given).

polygon: [
	40.078811,
	-76.730422,
	41.078811,
	-74.730422,
	40.078811,
	-74.730422,
	39.961879,
	-76.730422,
	39.961879,
	-76.730422,
	40.078811,
	-76.730422
]
          
<polygon>
	<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>
	<latLng>
		<lat>40.078811</lat>
		<lng>-76.730422</lng>
	</latLng>     
</polygon>
locations
Location[]
This is three or more location nodes that make up the request's polygon (This is only returned is locations was given).

{
  "geocodeQualityCode":"A5XAX",
  "type":"s",
  "adminArea3":"PA",
  "street":"",
  "dragPoint":false,
  "sideOfStreet":"N",
  "adminArea4Type":"County",
  "adminArea3Type":"State",
  "postalCode":"",
  "latLng":{
	"lat":40.0378,
	"lng":-76.305801
  },
  "adminArea1":"US",
  "adminArea5Type":"City",
  "adminArea1Type":"Country",
  "adminArea5":"Lancaster",
  "adminArea4":"Lancaster County",
  "linkId":0,
  "geocodeQuality":"CITY"
}

<origin>
  <street/>
  <adminArea5 type="City">
	Lancaster
  </adminArea5>
  <adminArea3 type="State">
	PA
  </adminArea3>
  <adminArea4 type="County">
	Lancaster County
  </adminArea4>
  <postalCode/>
  <adminArea1 type="Country">
	US
  </adminArea1>
  <geocodeQuality>
	CITY
  </geocodeQuality>
  <geocodeQualityCode>
	A5XAX
  </geocodeQualityCode>
  <dragPoint>false</dragPoint>
  <sideOfStreet>N</sideOfStreet>
  <linkId>0</linkId>
  <type>s</type>
  <latLng>
	<lat>40.0378</lat>
	<lng>-76.305801</lng>
  </latLng>
</origin>

 

Advanced Polygon Search Sample


Options Value(s)
Polygon:
Locations:
Ambiguities:
Units:
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