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).
|
|
|
| locations Location[] |
This is three or more location nodes that make up the request's polygon (This is only returned is locations was given).
|
|
|
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)