Geocode Activity

Description

Find address candidate locations for a given address.

Offline Support

This activity does not work when the device is offline.

Inputs

Url

Required

Type: String

The URL of the ArcGIS geocoding service.

For example, http://server/arcgis/rest/services/<serviceName>/GeocodeServer.

Address

Required

Type: String | Lookup<any>

The various address fields accepted by the corresponding geocode service. These fields are listed in the addressFields property of the JSON representation of the associated geocode service.

For example: Suppose that addressFields of a geocode service resource includes fields with the following names: Street, City, State, and Zone. If you want to perform the Geocode operation by providing values for the Street and Zone fields, you'd set the query parameters as Street: 380 New York St, Zone: 92373.

Max Locations

Optional

Type: Number

The maximum number of locations to be returned by a search, up to the maximum number allowed by the geocode service. If not specified, the maximum number of candidates for which the service is configured will be returned.

This parameter was added at 10.3, and is only supported by geocode services published with ArcGIS 10.3 for Server and later versions.

Out Fields

Optional

Type: String | String[]

The comma separated list of fields to be included in the returned result set. If you specify the shape field in the list of return fields, it is ignored.

For non-intersection addresses, you can specify the candidate fields from the geocode service resource.

For intersection addresses, you can specify the intersection candidate fields from the geocode service resource.

For example: [StreetName,StreetType].

outFields = [*] returns all fields.

Out Spatial Reference

Optional

Type: Number | String | esri.SpatialReference (3.x, 4.x)*

The spatial reference of the returned address candidates. For a list of valid WKID values, see http://resources.arcgis.com/EN/HELP/REST/APIREF/PCS.HTML and http://resources.arcgis.com/EN/HELP/REST/APIREF/GCS.HTML.

Search Extent

Optional

Type: Number[] | esri.Extent (3.x, 4.x)*

The spatial extent (bounding box) to be used in geocoding.

The response will return only the candidates that are within this spatial extent. Unless the spatialReference is included in the searchExtent, the coordinates are assumed to be in the spatial reference of the locator.

If comma-separated values are used, they must be in the following format: <XMin>,<YMin>,<XMax>,<YMax>. The searchExtent coordinates should always use a period as the decimal separator even in countries where a comma is traditionally used.

This optional parameter is supported only for services that use locators created using ArcGIS 10.0 or later.

Location

Optional

Type: Number[] | esri.Point (3.x, 4.x)*

Defines an origin point location that is used with the distance parameter to sort geocoding candidates based on their proximity to said location. The distance parameter specifies the radial distance from the location in meters. If a distance is not specified, it defaults to 2000 meters.

The location parameter can be represented by a Point object or as a comma-separated list. The spatial reference can be specified if a Point is used; otherwise the spatial reference is assumed to be the same as that of the geocoding service. If comma-separated values are used, they must be in the following format: <XCoordinate>,<YCoordinate>.

This parameter was added at 10.3 and is only supported by geocode services published with ArcGIS 10.3 for Server and later versions.

Distance

Optional

Type: Number

The radius of an area around a point location that is used to boost the rank of geocoding candidates so that candidates closest to the location are returned first. The distance value is in meters. If the distance parameter is specified, the location parameter must be specified as well.

Timeout

Optional

Type: Number

The time span in milliseconds to wait for the request's results.

* Geocortex Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of application. Web AppBuilder 2D apps and Geocortex HTML5 viewers use version 3.x of the JavaScript API. Web AppBuilder 3D apps use version 4.x.

Outputs

candidate

Type: esri.AddressCandidate (3.x, 4.x)*

The first candidate address.

candidates

Type: esri.AddressCandidate[] (3.x, 4.x)*

The candidate addresses.

spatialReference

Type: esri.SpatialReference (3.x, 4.x)*

The result spatial reference.

* Geocortex Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of application. Web AppBuilder 2D apps and Geocortex HTML5 viewers use version 3.x of the JavaScript API. Web AppBuilder 3D apps use version 4.x.

Properties

For information about the ID, Display Name, and Description properties, see Properties Common to all Activities.

Version Information

Supported from: Geocortex Viewer for HTML5 2.9, Web AppBuilder for ArcGIS 2.4.

© 2018 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 5.9