Display Name: GeocodeFile

Description: GeocodeFile

Category:

Help URL: https://oehsportal.wvdhhr.org/arcgis/rest/directories/arcgisoutput/Utilities/GeocodingTools_GPServer/Utilities_GeocodingTools/GeocodeFile.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: geocodeParameters

Data Type: GPString
Display Name geocodeParameters
Description: Input a JSON string, the output of AnalyzeGeocodeInput. The generated field mapping should be reviewed before submitting your BatchGeocode job, otherwise you may end up with unexpected results. Make sure to escape characters that are strings inside strings. Example input:{"field_info": "[[\"OBJECTID\", \"TEXT\", 255], [\"SingleLine\", \"TEXT\", 255], [\"Address\", \"TEXT\", 255], [\"Neighborhood\", \"TEXT\", 255], [\"Admin1\", \"TEXT\", 255], [\"Admin2\", \"TEXT\", 255], [\"Admin3\", \"TEXT\", 255], [\"City\", \"TEXT\", 255], [\"Subregion\", \"TEXT\", 255], [\"Region\", \"TEXT\", 255], [\"Postal\", \"TEXT\", 255], [\"PostalExt\", \"TEXT\", 255], [\"Country\", \"TEXT\", 255]]","column_names": "","file_type": "csv","column_delimiter": "","text_qualifier": "","field_mapping": "[[\"SingleLine\", \"SingleLine\"], [\"Address\", \"Address\"], [\"Neighborhood\", \"Neighborhood\"], [\"City\", \"City\"], [\"Subregion\", \"Subregion\"], [\"Region\", \"Region\"], [\"Postal\", \"Postal\"], [\"PostalExt\", \"PostalExt\"], [\"Admin1\", \"\"], [\"Admin2\", \"\"], [\"Admin3\", \"\"], [\"Country\", \"CountryCode\"]]","singleline_field": "SingleLine","header_row_exists": true} Note: if using AnalyzeGeocodeInput for GeocodeFile, make sure to pass columnNames and inputServiceURL since AnalyzeGeocodeInput does not accept zip file inputs.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: geocodeServiceURL

Data Type: GPString
Display Name geocodeServiceURL
Description: The geocode service that should geocode the input table. The service should support batch geocoding and have a geocodeAddresses REST endpoint. This URL should end in GeocodeServer
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: outputType

Data Type: GPString
Display Name outputType
Description: Possible options are "csv", "xls" or "gdb". Output is a zipped version of one of those file types.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: inputFile

Data Type: GPDataFile
Display Name inputFile
Description: Must be a zipped file already uploaded to ArcGIS Server. Example: {"itemID":"i5df6d71b-c08c-4bdf-a075-be6acb6de930"}
Direction: esriGPParameterDirectionInput
Filter:
Type: File
List:
• zip
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: tableName

Data Type: GPString
Display Name tableName
Description: Name of the sheet if the input is a zipped xlsx. Name of the table if the input is a zipped gdb.Example: "Sheet1"
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: sourceCountry

Data Type: GPString
Display Name sourceCountry
Description: Acceptable values include the full country name, the ISO 3166-1 2-digit country code, or the ISO 3166-1 3-digit country code.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: category

Data Type: GPString
Display Name category
Description: Enter a category if your geocoding service supports it
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: outputFields

Data Type: GPString
Display Name outputFields
Description: Enter the output fields that you want to recieve from the geocoding service, separated by commas. Example: "x,y,score,match_addr"
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: headerRowsToSkip

Data Type: GPLong
Display Name headerRowsToSkip
Description: Default is 1. If there is no header row, enter 0. If there are empty rows after the header, add them to the one header row and enter the number
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 1
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: outputName

Data Type: GPString
Display Name outputName
Description: Additional properties such as output feature service name
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: context

Data Type: GPString
Display Name context
Description: Additional settings such as processing extent and output spatial reference
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: locatorParameters

Data Type: GPString
Display Name locatorParameters
Description: JSON input can include more geocoding properties. Another way to pass sourceCountry or category. The only way to pass locationType.Example: {"locationType":"rooftop"}
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: geocodeResult

Data Type: GPDataFile
Display Name geocodeResult
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: geocodingStatistics

Data Type: GPString
Display Name geocodingStatistics
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata