locator

The address argument is data object that contains properties representing the various address fields accepted by the corresponding geocode service. These fields are listed in the addressFields property of the associated geocode service resource. For example, if the addressFields of a geocode service resource includes fields with the following names: Street, City, State and Zone, then the address argument is of the form:

{
  Street: "1234 W Main St",
  City: "Small Town",
  State: "WA",
  Zone: "99027"
}

Locators published using ArcGIS 10 or later support a single line address field, which can be specified using the following syntax where field_name is the name of the single line address field. You can find this name by viewing the help or services directory for your locator services. Common values are SingleLine and SingleLineFieldName:

let address = {
  "field_name": "380 New York St, Redlands, CA 92373"
};

The Services Directory can be used to find out the required and optional address fields and the correct names for the input name fields. If you are using the World Geocoding Service visit the ArcGIS Online Geocoding Service help for more details on the World Geocoder.

Limit result to one or more categories. For example, "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service. See Category filtering (World Geocoding Service) for more information.

Limit result to a specific country. For example, "US" for United States or "SE" for Sweden. Only applies to the World Geocode Service. See Geocode coverage (World Geocoding Service) for more information.

Allows the results of single geocode transactions to be persisted.

Used to weight returned results for a specified area.

Define the type of location, either "street" or "rooftop", of the point returned from the World Geocoding Service.

A suggestLocations result ID (magicKey). Used to query for a specific results information.

Maximum results to return from the query.

The list of fields included in the returned result set. This list is a comma delimited list of field names. 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 as defined in the geocode service. For intersection addresses you can specify the intersection candidate fields.

The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if finding locations by address.

Defines the extent within which the geocode server will search. Requires ArcGIS Server version 10.1 or greater.

The input addresses in the format supported by the geocode service. If the service supports 'Single Line Input' the input addresses will be in the following format:

{
  "OBJECTID": 0,
  "Single Line Input":"77 Main St, Plymouth, NH 03264"
}

Limits the results to only search in the country provided. For example US for United States or SE for Sweden. Only applies to the World Geocode Service. See the World Geocoding Service documentation for more information.

Limit result to one or more categories. For example, "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service. See Category filtering (World Geocoding Service) for more information.

Define the type of location, either "street" or "rooftop", of the point returned from the World Geocoding Service.

The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if finding locations by address.

The point at which to search for the closest address. The location should be in the same spatial reference as that of the geocode service.

Define the type of location, either "street" or "rooftop", of the point returned from the World Geocoding Service.

The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries when performing a reverse geocode and in the default spatial reference returned by the service if finding locations by address.

A place or address type which can be used to filter suggest results. The parameter supports input of single category values or multiple comma-separated values.

Defines a normalized location point that is used to sort geocoding candidates based upon their proximity to the given location.

The input text entered by a user which is used by the suggest operation to generate a list of possible matches.