Rectangle Search Request
Contents
Parameters
Below are request and response parameters that are unique to a Rectangle Search. Refer to the Common Parameters page for information on request and response parameters common in all searches.
Request Parameters
| Name | Description |
|---|---|
| boundingBox Bounding Box |
This is the bounding box that makes up the search rectangle's corners. A boundingBox takes exactly two points, the top left and bottom right. It then calculates a rectangle based on those corners and searches the area inside.
This is a required parameter if the locations parameter is not supplied! |
| locations Location[] |
This parameter will take exactly two locations (addresses or IP addresses) to use to determine the search rectangle's upper left and lower right corners.
This is a required parameter if the boundingBox parameter is not supplied! |
Response Parameters
| Name | Description | JSON Example Return Value(s) | XML Example Return Value(s) |
|---|---|---|---|
| boundingBox BoundingBox |
The bounding box that makes up the rectangle boundary search, either entered in the request, or created from the provided locations in the request (This is only returned is a boundingBox was given).
|
|
|
| locations Location[2] |
This is two location nodes that make up the request's bounding box (This is only returned is locations was given).
|
|
|
Advanced Rectangle Search Sample
| Options | Value(s) |
|---|---|
| Bounding Box: | |
| Locations: |
|
| Ambiguities: | |
| Units: | |
| Max Matches: | |
| Shape format: | |
| Current Page: | |
| Page Size: | |
| Input Format: | |
| Output Format: | |
| Map Data: | |
| Hosted Data: | |
| Remote Data: |
(Output will be displayed below)