Geocode Addresses

Description: The response format. The default response format is html.

Values: html | json | kmz

Description: A record set representing the addresses to be geocoded. Each record must include an OBJECTID attribute with a unique value, as well as various address fields accepted by the corresponding geocode service. The field names that should be used can be found in the JSON representation of the geocode service resource under the addressFields property, for multiple input field geocoding, or the singleLineAddressField property, for single input field geocoding. The OBJECTID specified in the request is reflected as ResultID in the response.

The maximum number of addresses that can be geocoded in a single request is limited to the SuggestedBatchSize property of the locator.

Syntax:

{ 
"records"  : [
{
   "attributes" : {"<OBJECTID>" : "<OID11>","<field1>" : "<value11>", "<field2>" : "<value12>", "<field3>" : "<value13>"}
},
{
   "attributes" : {"<OBJECTID>" : "<OID21>","<field1>" : "<value21>", "<field2>" : "<value22>", "<field3>" : "<value23>"}
}
]
}

Example 1: The addressFields of a geocode service resource includes fields with the names Street and Zone. You can provide the input for addresses as follows:

{       
    "records": [
        {
            "attributes": {
                "OBJECTID": 1,
                "STREET": "440 Arguello Blvd",
                "ZONE": "94118"
            }
        },
   {
            "attributes": {
                "OBJECTID": 2,
                "STREET": "450 Arguello Blvd",
                "ZONE": "94118"
            }
        }
    ]
}

Example 2: Using a single line address input, where SingleLine is the name of the singleLineAddressField property of the Geocode Service:

{       "records": [
        {
            "attributes": {
                "OBJECTID": 1,
                "SingleLine": "440 Arguello Blvd, San Francisco, CA 94118"
            }
        },
   {
            "attributes": {
                "OBJECTID": 2,
                "SingleLine": "450 Arguello Blvd, San Francisco, CA 94118"
            }
        }
    ]
}

Description: The well-known ID of the spatial reference, or a spatial reference json object for the returned addresses. For a list of valid WKID values, see Projected coordinate systems and Geographic coordinate systems.

Description: The sourceCountry parameter is only supported by geocode services published using StreetMap Premium locators.

Added at 10.3 and only supported by geocode services published with ArcGIS 10.3 for Server and later versions.

The category parameter is only supported by geocode services published using StreetMap Premium locators.

Added at 10.3 and only supported by geocode services published with ArcGIS 10.3 for Server and later versions.