- URL:
- https://<geocodeservice-url>/geocode-enterprise-table
- Methods:
GET
- Version Introduced:
- 10.9
The Geocode
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.
Request URL
https://<analysis-url>/GeocodeEnterpriseTable/submitJob
Request parameters
Parameter | Description |
---|---|
(Required) | This includes parameters that help parse the table, as well the field lengths and a field mapping. This JSON is the output from Syntax values:
Example
|
(Required) | Enter the REST URL of the geocode service that you want to geocode your addresses or places against. The URL must end in |
(Required) | Specifies the output type that is returned. Values: |
(Required) | 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. Syntax values:
Syntax
|
(Optional) | This parameter will limit geocoding to the country or countries specified. Specifying the country where the addresses or places are from in the This is limited to the specified country or countries and when no Example
|
(Optional) | 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:
See the ArcGIS REST API web help for details about category filtering. Example
|
(Optional) | Specifies which geocode service output fields are appended to the Parameter options:
Example
|
(Optional) |
If provided, the task will create a feature service of the results. You define the name of the service. If an Syntax:
In ArcGIS Online or ArcGIS Enterprise 10.9.1 and later, you can overwrite an existing feature service by providing the Syntax:
or
|
(Optional) |
The Context parameter contains the following additional settings that affect task operation:
Syntax:
|
(Optional) | This parameter takes a dictionary that can contain any or all of the following optional geocoding parameters:
Syntax
|
| The response format. The default response format is Values: |
Response
When you submit a request, the service assigns a unique job ID for the transaction.
Syntax
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}
After the initial request is submitted, you can use job
to periodically check the status of the job and messages as described in Checking job status. Once the job has successfully completed, use job
to retrieve the results. To track the status, you can make a request in the following form:
https://<analysis-url>/GeocodeEnterpriseTable/jobs/<jobId>
Access results
When the status of the job request is esri
, 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
Parameter | Description |
---|---|
|
|