SpatialStream® Web Services - AddressLoader Reference

AddressLoader Reference

Service that provides a way to upload a CSV address file and Geocode each address in order to use as a layer. The .csv file must be POSTed along with the request.

Input

Parameter name	Type	Description
output	String	The output type for the page. Possible types include 'XML', 'JSON', 'JSONXML', 'HTML', and 'CUSTOM'.
obsId	String	(Required for JSON/JSONXML output) The object listening for the JSON callback.
obsSuccessMethod	String	(Required for JSON/JSONXML output) The JSON success callback function.
obsErrorMethod	String	(Required for JSON/JSONXML output) The JSON error callback function.
transformer	String	(Required for CUSTOM output) The XSLT to use to transform the XML output.
maxError	Integer	The maximum number of errors to allow. If exceeded, data load will be aborted. If not specified, no limit will be set.
autoPublishLayers	Comma separated alpha-numeric string	Layers to automatically publish after the data load is complete.
resourceName	Comma separated alpha-numeric string	(Required) The name of the resource to populate data with.
interactive	Boolean or auto	Determines if address load is sent to the queue or processed interactively. There are 3 ways to specify the load type: true - Always loads interactively false - Always loads using queue; email is required. auto (default) - Loads interactively if filesize is sufficiently small, loads to queue otherwise; email is required.
email	E-mail address	E-mail to use to send the notifications to. Required if interactive is false or auto.
foreignKey	Comma separated alpha-numeric string	(Required if CSV contains record updates) Field(s) used to identify records to be updated.
processName	Alpha-numeric string	The name of the job process.
processDescription	Alpha-numeric string	The description of the job process.

Output

An XML response confirming if the job request is successful or not.