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.


Parameter nameTypeDescription
outputString The output type for the page. Possible types include 'XML', 'JSON', 'JSONXML', 'HTML', and 'CUSTOM'.
obsIdString (Required for JSON/JSONXML output) The object listening for the JSON callback.
obsSuccessMethodString (Required for JSON/JSONXML output) The JSON success callback function.
obsErrorMethodString (Required for JSON/JSONXML output) The JSON error callback function.
transformerString (Required for CUSTOM output) The XSLT to use to transform the XML output.
maxErrorInteger The maximum number of errors to allow. If exceeded, data load will be aborted. If not specified, no limit will be set.
autoPublishLayersComma separated alpha-numeric string Layers to automatically publish after the data load is complete.
resourceNameComma separated alpha-numeric string(Required) The name of the resource to populate data with.
interactiveBoolean 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.
emailE-mail address E-mail to use to send the notifications to. Required if interactive is false or auto.
foreignKeyComma separated alpha-numeric string (Required if CSV contains record updates) Field(s) used to identify records to be updated.
processNameAlpha-numeric string The name of the job process.
processDescriptionAlpha-numeric string The description of the job process.


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