GetByGeometry Reference
Input
| Parameter name | Type | Description |
|---|---|---|
| fields | Comma separated alpha-numeric string | Comma separated list of columns to return. Supports chained fields. |
| showSchema | Boolean | Set to true to see all the field definitions in the response layers. Default: true |
| output | String | The output type for the page. Possible types include 'XML', 'JSON', 'JSONXML', 'HTML', 'CSV', 'excel.sheet', and 'CUSTOM'. |
| obsId | String | (Required for JSON/JSONXML output) The object listening for the JSON callback. |
| obsSuccessMethod | String | (Required for JSON/JSONXML output) The JSON success callback function. |
| obsErrorMethod | String | (Required for JSON/JSONXML output) The JSON error callback function. |
| transformer | String | (Required for CUSTOM output) The XSLT to use to transform the XML output. |
| dataSource | Comma separated alpha-numeric string | (Required) The name of the data source to query against. |
| geo | Well-known text | (Required) Well Known Text(WKT) Geometry to filter the results by. |
| geoBufferDist | Positive decimal | A distance to expand the geometry for a buffered search. |
| geoBufferUnit | Alpha-numeric string | The units used for geoBufferDist. Must be one of the following: 1 = mile, 2 = kilometer, 3 = meter (default), 4 = feet |
| returnGeoType | Alpha-numeric string |
The returning geometry type. There are 3 return types.
|
| maxRecords | Comma separated alpha-numeric string |
The maximum number of results to return. Comma separated link names and their maximum number of results to
return may also be specified in the form LinkName(someNumber). Ex. ...datasource=Parcels&fields=*,PropertyLocation(TAX_ID)&maxRecords=50,PropertyLocation(3)... Means to return a max of 50 results for Pacels, and 3 results for the PropertyLocation link.) |
| sortRecords | Boolean | Sort the results by distance from the geometry. |
| excludeFieldName | Alpha-numeric string | The field name to use for the exclusion list (see exclusionFieldValues.) |
| excludeFieldValues | Comma separated alpha-numeric string | The exclusion list. This list is composed of comma separated field values. Any records matching this list will be excluded from the final result. |
| activeVersionId | Alpha-numeric string | Query will be performed on published records and records pending by the specified active version ID. |
| viewInTime | String | Format (optional hh:mm:ss): YYYY-MM-DD hh:mm:ss. Gets a snapshot of the matching records at the specified point in time. |
