- URL:
- https://<geocodeservice-url>/analyze-geocode-input
- Methods:
GET
- Version Introduced:
- 10.5
The Analyze
task takes in a geocode input (either a table or file of addresses) and returns an output JSON that includes a suggested field mapping. It supports CSV, XLS, or table input. The table can be from a big data file share or from a feature service. The task generates a suggested field mapping based on the input fields and the geocode service candidate fields and returns it in a geocode
JSON. This geocode
JSON output is the first input to the Batch Geocode tool. The output geocode
JSON also includes field info (name
, length
, and type
) as well as additional information that helps the BatchGeocode tool parse the input file or table.
Request URL
https://<analysis url>/AnalyzeGeocodeInput/submitJob
Request parameters
Parameter | Description |
---|---|
(Required) | The REST URL of the geocode service that you want to geocode your addresses and places against. The URL must end in |
(Optional) | Syntax: The input table specification must include the following:
Note that if the table is a hosted table on the same portal, Example
|
(Optional) | Syntax: The input file should be a portal item. Input the
Example
|
(Optional) | Instead of providing Example
|
(Optional) | Enter a JSON that contains information about how to parse the file. If you are using Values can be the following:
Example
|
(Optional) | Enter the two-letter |
(Optional) |
The Context parameter contains the following additional settings that affect task operation:
Syntax:
|
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>/AnalyzeGeocodeInput/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>/AnalyzeGeocodeInput/jobs/<jobId>/results/<output parameter name>?token=<your token>&f=json
Parameter | Description |
---|---|
|
Example
The result contains the
|