The GeocodeEnterpriseTable task geocodes columns from an Oracle, SQL Server or Postgres database table and appends location information for the addresses or places in the table, such as X and Y coordinate values, match address, score and other geocoding output fields to the original input table. Before using this task, you must first register the database that contains the table you want to geocode, by using ArcGIS Server Manager. For more information about registering your database in Server Manager, see Registering your data with Server Manager.
Note:The GeocodeEnterpriseTable API is only available in ArcGIS Enterprise and is not supported for ArcGIS Online.
This includes parameters that help parse the table, as well the field lengths and a field mapping. This JSON is the output from AnalyzeGeocodeInput. It is important to inspect the field mapping and adjust it accordingly before submitting your job, otherwise your geocode results may not be accurate. It is recommended that you use the output from AnalyzeGeocodeInput, and modify the field mapping instead of constructing this JSON by hand and passing it in.
Enter the REST URL of the geocode service that you want to geocode your addresses or places against. The URL must end in geocodeServer and allow batch requests. This can be a utility service or a locator that is anonymously accessible. The geocode service must be configured to allow batch geocoding. For more information, see Configuring batch geocoding
Specifies the output type that is returned.
The path and fully qualified table name in the enterprise geodatabase that contains the addresses and places to be geocoded.
The database must be registered your database with ArcGIS Server before a table from the database can be used by this tool. For more information about registering your database with ArcGIS Server in ArcGIS Server Manager, see Registering your data with Server Manager.
This parameter will limit geocoding to the country or countries specified. Specifying the country where the addresses or places are from in the tableName will improve the accuracy of geocoding in most cases. If a field representing countries in the tableName is mapped to the input Country field from the geocode service in field_mapping, the country value from the tableName will override the sourceCountry parameter.
This is limited to the specified country or countries and when no sourceCountry is specified, geocoding is performed against all supported countries of the locator. The input value can be specified as either 2-character or 3-character country codes in a comma-separated list. See the Supported Country Codes column for the input value to use.
Not all geocode services support sourceCountry.
Limits the types of places the geocode service searches, which eliminates false positive matches and potentially speeds up the search process. When no category is used, geocoding is performed against all supported categories. In general, the parameter can be used for the following:
Not all geocode services support category.
See the ArcGIS REST API web help for details about category filtering.
Specifies which geocode service output fields are appended to the tableName.
If provided, the task will create a feature service of the results. You define the name of the service. If an outputName value is not provided, the task will return a feature collection. Syntax: Syntax:
The Context parameter contains the following additional settings that affect task operation:
This parameter takes a dictionary that can contain any or all of the following optional geocoding parameters:
The response format. The default response format is html.
Values: html | json
When you submit a request, the service assigns a unique job ID for the transaction.
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
After the initial request is submitted, you can use jobId to periodically check the status of the job and messages as described in Checking job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request in the following form:
When the status of the job request is esriJobSucceded, you can access the results of the analysis by making a request in the following form:
https://<analysis-url>/GeocodeEnterpriseTable/jobs/<jobId>/results/<output parameter name>?token=<your token>&f=json
geocodingStatistics output JSON includes statistics about the batch geocoding job. The result has properties for parameter name, data type, and value. The value contains the JSON of percentages for matched, unmatched, and tied records in the batch geocoding job. It may also contain "Dropped Records", an additional list of ObjectIDs for the records that were unable to be processed.