Parameters - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

geocodeAddresses uses required and optional parameters in a POST request to batch geocode multiple addresses.

Parameter Details
f

Required: The response format in json, html or kmz. For the Geocoding Connector, the supported format is json.

addresses

Required: Addresses for batch geocoding. SingleLine and multiline addresses are supported.

outFields Optional: The list of fields to be returned.
outSR Optional: The well-known ID (WKID) of the spatial reference or a spatial reference JSON object for the returned address candidates.
maxLocations Optional: The maximum number of locations to be returned.
MaxBatchSize Optional: Defines the limit of addresses that can be geocoded in a single request. We recommend a batch size of 100-200 addresses.
SuggestedBatchSize Optional: Specifies the optimal number of addresses to include in a single batch request given the power of the server and the bandwidth.
sourceCountry Optional: Defines the source country for the addresses.
matchOutofRange Not supported.
locationType Not supported.

Example

This is an example for the addresses parameter.

{
    "records": [
        {
            "attributes": {
                "OBJECTID": 1,
                "Address": "10 greenhill rd",
                "Neighborhood": "",
                "City": "wayville",
                "Subregion": "",
                "Region": "SA",
                "countryCode": "AUS"    
               }
           },    
           {    
                "attributes": {
                "OBJECTID": 2,    
                "singleLine": "10 downing street London SW1A 2AA",
                "countryCode": "GBR"
               }
            },
            {
                "attributes": {
                "OBJECTID": 3,
                "Address": "1600 PENNSYLVANIA AVE NW",
                "Neighborhood": "",
                "City": "Washington",
                "Subregion": "",
                "Region": "D",
                "countryCode": "USA"
                }
            }
       ]
  }