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 address fields for the geocode service to use. These fields are listed in the addressFields property of the JSON representation of the geocode service.

For example, suppose that a geocode service's addressFields includes fields with the following names: Street, City, State, and Zone. If you want to perform the geocode operation on the Street and Zone fields, set the Address input to ={Street: "380 New York St", Zone: "92373"}.

If the geocode service has a singleLineAddressField named singleLine, you can use a string value as the Address input, for example: 380 New York St. If the singleLineAddressField has a different name, for example Single Line Input, you could set the Address input to ={"Single Line Input": "380 New York St, Redlands, CA, 92373"} to uniquely identify the address.

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.

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.

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

For example: [StreetName,StreetType].

To return all fields, set Out Fields to this: outFields = [*]

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. The coordinates are assumed to be in the spatial reference of the locator, unless the spatialReference is included in the searchExtent.

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.

Location

Optional

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

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

The location input 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>.

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 input is specified, the location input must be specified as well.

Timeout

Optional

Type: Number

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

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.