- URL:
- https://<geocodeservice-url>/geocode-file
- Methods:
GET
- Version Introduced:
- 10.7
The Geocode
task geocodes a zipped table or file of addresses and returns the geocoded results. It supports zipped CSV and XLS files and geodatabase table input. The task geocodes the entire file regardless of its size.
Request URL
https://<analysis-url>/GeocodeFile/submitJob
Request parameters
Parameter | Description |
---|---|
(Required) | This includes parameters that help parse the file, the field lengths, and field mapping. This JSON is the output from Syntax values:
Example
|
(Required) | The REST URL of the geocode service you want to geocode your addresses against. The URL must end in |
(Required) | Specifies the file type to which the geocode results will be written. Values: |
(Required) | The input file that contains addresses or places to geocode in a zipped CSV file, XLSX file, or zipped file geodatabase table. The file must already be uploaded to ArcGIS Server. Syntax
|
(Optional) | The name of the table that contains the addresses or places to geocode in the Use the name of the table if the Example
|
(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, you can use the parameter for the following:
See the ArcGIS REST API web help for details about category filtering. Example
|
(Optional) | Specifies which geocode service output fields are returned in the geocode results. The parameter options are the following:
Example
|
(Optional) | Describes the first row containing data to be geocoded in the file or table. The default value is 1 since the first row contains the field headers. 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>/GeocodeFile/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>/GeocodeFile/jobs/<jobId>/results/<output parameter name>?token=<your token>&f=json
Parameter | Description |
---|---|
|
|
|
|