Url

Required

Type: String

The URL of the geocoding service.

Location

Optional

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

The point at which to search for the closest address.

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>.

Distance

Optional

Type: Number

Specifies the radius of an area around a point location that should be searched.

The distance value is in meters.

If the distance parameter is not specified or invalid, a default value of 0 meters is used.

Out Spatial Reference

Optional

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

The spatial reference for the returned address candidates.

Language Code

Optional

Type: String

The language code.

Note: Only supported by geocode services published using StreetMap Premium locators.

Return Intersection

Optional

Type: Boolean

Determines whether the geocode service should return the nearest street intersection or the nearest address to the given point.

If true, then the closest intersection to the input location is returned.

If false, then the closest address to the input location is returned.

The default value is false.

Note: This parameter is only valid for geocode services that support intersections. A geocode service that supports intersections will include the IntersectionConnectors property in the service description.

Timeout

Optional

Type: Number

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

Continue On Error

Optional

Type: Boolean

Determines whether the activity should continue if it encounters an error.

If true, then continue on error.

The default value is false.

address

Type: Object

The result address.

location

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

The result address location.