Basic Search Request
The basic search service allows a search of a data to be made by inputting a shape to search.
Contents
Parameters
Below are request and response parameters that are unique to a Base Search. Refer to the Common Parameters page for information on request and response parameters common in all searches.
Request Parameters
The base search function only has one unique parameter, shapePoints. For all other common parameters, refer to the Common Parameters page.
The shapePoints parameter takes one or more points.
- One Point - This will perform a radius search from the point given.
- Multiple Points (matching starting and ending points) - This will create a polygon shape from those points and search the area inside.
- Multiple Points (different starting and ending points) - This will search along the line made from the points given (especially useful when trying to search along a route).
Response Parameters
The following table describes the parameters returned in the Response
| Name | Description | JSON Example Return Value(s) | XML Example Return Value(s) |
|---|---|---|---|
| shapePoints Geometry |
The shapePoints parameter can be used to input a geometry to search.
This is a required parameter if the origin parameter is not supplied.
|
|
|
| radius Double |
Distance from the origin searched. (This parameter is returned if the shapePoints given was a single point.
|
radius: 20.0
|
<radius>20.0</radius>
|
Advanced Search Sample
| Options | Value(s) |
|---|---|
| Shape: | |
| Units: | |
| Max Matches: | |
| Shape format: | |
| Current Page: | |
| Page Size: | |
| Input Format: | |
| Output Format: | (Currently only works with JSON) |
| Map Data: | |
| Hosted Data: | |
| Remote Data: |
(Output will be displayed below)