Titleā€ƒ AnalyzeGeocodeInput


Analyze File auto-generates a field mapping for the input table or file provided, and outputs GeocodeParameters JSON. The JSON output is a required parameter for the BatchGeocode Tool.



Parameter Explanation

The geocode service that should geocode the input table or file. The service should support batch geocoding and have a geocodeAddresses REST endpoint. This URL should end in GeocodeServer

inputTable (Optional)

The portal item URL of a table in an input feature service to be geocoded. ServiceToken does not need to be rpovided if the table is on the hosting server. Example input: {"url":"<serverURL>/rest/services/Hosted/input_table/FeatureServer/0","serviceToken":"<token>"}

inputFileItem (Optional)

The itemid of the portal file as input to the geocoding service. The itemid should correspond to a CSV or Microsoft Excel file in the Portal. Example input: {"itemid":"b5606093e2c24851a499d6f25676e823"}

columnNames (Optional)

If your file does not contain a header row, then "columnNames" CANNOT be empty. Specify the column names separated by commas, like so: address,city,state,zip. You can also pass this instead of passing an inputFile or inputTable.

inputFileParameters (Optional)

Enter the JSON of input file Parameters. Example JSON:

{"fileType": "xlsx","headerRowExists": "true","columnDelimiter":"","textQualifier":""}

locale (Optional)

If your data is not English, make sure to fill out your locale in order to ensure a language-specific field mapping. Enter a 2-letter or 4-letter specific locale. Examples include "en" or "ar-bh"

context (Optional)

Additional settings such as processing extent and output spatial reference.

Code Samples


Batch Geocoding


This tool does not cost any credits to use.

Use limitations