NSW Point

Documentation Roadmap


NSW Point provides a range of geocoding services for NSW Government agencies. The services are as follows:


Web Service Web Service Description
Common Definitions, Acronyms and Abbreviations Description: List of common definitions, acronyms, abbreviations and error messages found in NSWPoint

Link: For more information see Common Definitions, Acronyms and Abbreviations Reference Guide.
Predictive Text Widget Description: This is a GUI element that can be embedded in an HTML web page. The widget provides web page users a simple means of entering Australian physical addresses into an HTML form.

Link: NSW Point Address Widget Installation Guide explains how to embed the widget in a web page, and how to customise its behaviour and appearance.

NSW Point Widget Sample Web Page is a sample web page that embeds the widget and allows you to see how different customisation configurations behave.
address-validation-parsed web service Description: This web service accepts a JSON object composed of parsed address components for validation

Link: For more information see address-validation-parsed API Reference Guide.
address-validation-unparsed web service Description: This web service accepts a complete address as a string for validation

Link: For more information see address-validation-unparsed API Reference Guide.
address-validation-predictive1 web service Description: This web service accepts a partial address string and returns possible known addresses that match the proposed string

Link: For more information see address-validation-predictive1 API Reference Guide.
address-validation-predictive2 web service Description: This web service accepts an id provided by the Predictive web service and returns more information about the selected address

Link: For more information see address-validation-predictive2 API Reference Guide.
Lot/dp web services Description: This web service accepts a geocode such as one provided by the Predictive2 web service, identifies the property the geocode falls within and returns all the lots within that property

Link: For more information see Lot/dp web services
Admin Boundaries web services Description: This web service accepts a geocode such as one provided by the Predictive2 web service, identifies the administrative localities the geocode falls within and returns the name and ID of Commonwealth, State Electoral and LGA information

Link: For more information see Administrative Boundaries web services
ESRI enabled geocoder predictive1 service Description: This web service behaves in a similar manner to the predictive1 web service with the exception that it accepts and responds in a manner compatible with some ERSI Services.

Link: For more information see ESRI enabled geocoder predictive1
ESRI enabled geocoder predictive2 service Description: This web service behaves in a similar manner to predictive2 web service with the exception that it accepts and responds in a manner compatible with some ERSI Services.

Link: For more information see ESRI enabled geocoder predictive2
Embedding the ESRI enabled geocoder into a widget Description: This page describes in detail how to embed the ESRI enabled geocoder in developers.arcgis.com/ based widgets

Link: For more information see ESRI enabled geocoder


Release Notes


01/10/2018

Changes to:
  • predictive1
  • predictive2
  • address-validation-parsed
  • address-validation-unparsed
  • widget
    • Introduction of:
  • Lot/DP
  • Administrative Boundaries
      • Widget:
    • Input: No change to the input. Changes are in configuration options
    • Output: Lot DP and Administrative Boundaries information
    • Behaviour: User can customise the widget to search and return data from GNAF, PAF, LOT/DP and Administrative Boundaries data sets.
      The user can also configure the widget to limit the search to a specific set of states The user can also configure the number of addresses returned, 1-10 inclusive

      Predictive1:
      Security improvements only
    • Input: No observable changes
    • Output: No observable changes
    • Behaviour: No observable changes

      Predictive2:
    • Input: No Observable changes
    • Output:timestamp now in local time
      added addressIdentifier, geoFeature and primarySecondary
    • Behaviour:No observable changes

      Address-Validation-parsed:
    • Input: Parsed is now an optional input. Does not affect output.
    • Output: timestamp now in local time
      added addressIdentifier, geoFeature and primarySecondary to response
      added matchQualityPercentage to response. - MatchQualityPercentage is equivalent to matchResult. - MatchResult will be depreciated in the next release. added state electoral class code to response. This value will provide context and aid in interpreting the state electoral information.
    • Behaviour: Function now returns better error messages for improper input.

      Address-Validation-unparsed:
      Address Validation Unparsed includes the same updates as Address Validation Parsed.
    • Input:
    • Output:
    • Behaviour:
      Lot/DP:
      Only applicable for locations within NSW
    • Input: Geocode (in WGS or GDA94)
    • Output: Data object containing a list of lots associated with a property id
    • Behaviour: Lot/DP is only available for NSW addresses and requests data from NSW Spatial Services data sets.

      Administrative Boundaries:
    • Input: Geocode (in WGS or GDA94)
    • Output: JSON object containing information about Australian Bureau of Statistics, LGA, State Electoral and Commonwealth administrative juristictions
    • Behaviour: Administrative Boundaries takes a geocode and searches a national dataset for a set of administative boundaries pertinent to that geocode

      ESRI enabled Geocoder: Suggest
    • Input: partial address string
    • Output: Array of potential addresses that match the input string
    • Behaviour: Suggest behaves in a similar manner to to Predictive 1, but responds in a format compatible with ESRI web app products

      ESRI Enabled Geocoder: findAddressCandidates
    • Input: magicKey
    • Output: JSON object containing addressing information
    • Behaviour: findAddressCandidates behaves in a similar manner to Predictive 2, but responds in a format compatible with ESRI web apps.
    09/08/2018

    Changes to:
  • predictive1
  • predictive2
  • address-validation-parsed
  • address-validation-unparsed
  • widget
      • Widget:
    • Input: None
    • Output: None
    • Behaviour: User can customise widget to search and return data from GNAF, PAF, LOT/DP and Administrative Boundaries data sets
      User can also configure the widget to search a list of states and the number of addresses returned between 1 and 10 inclusive

      Predictive1:
    • Input: The addition of 2 new optional parameters: stateTerritory, maxNumberResults
    • Output: Up to 10 results instead of a hard limit of 5
    • Behaviour: None

      Predictive2:
    • Input: None
    • Output: Addition of request_timestamp, request_date,
      renaming of data.meshblock to data.properties.abs.mb_2016_code,
      renaming of data.SA1 to data.properties.abs.sa1_2016_code,
      renaming of data.properties.complexStreetNumber1 to data.properties.streetNumber1,
      renaming of data.properties.complexStreetNumber2 to data.properties.streetNumber2,
      renaming of data.properties.Cad_ID to data.properties.cadastralIdentifier ,
      renaming of data.properties.site_name to data.properties.siteName,
      renaming of data.properties.lot_Identifier to data.properties.lotIdentifier
    • Behaviour: Function no longer returns 204 status codes. Now if an id isn’t found, a 404 code with appropriate message is returned.

      Address-Validation-parsed:
    • Input: Parsed to be removed from documentation but not from code. Variable does not affect output.
    • Output: Addition of request_timestamp, request_date,
      renaming of data.meshblock to data.properties.abs.mb_2016_code,
      renaming of data.SA1 to data.properties.abs.sa1_2016_code
      addition of matchQualityPercentageDescription, addressIdentifier, geoType and matchCertainty to response
    • Behaviour: Function no longer returns 204 status codes.
      Now if an error occurs or an address isn’t found, the appropriate 404 code with message is returned.

      Address-Validation-unparsed:
    • Input: Parsed to be removed from documentation but not from code. Variable does not affect output.
    • Output: Addition of request_timestamp, request_date,
      renaming of data.meshblock to data.properties.abs.mb_2016_code,
      renaming of data.SA1 to data.properties.abs.sa1_2016_code
      addition of matchQualityPercentageDescription, addressIdentifier, geoType and matchCertainty to response
    • Behaviour: Function no longer returns 204 status codes.
      Now if an error occurs or an address isn’t found a 404 code with appropriate message is returned
    01/06/2018

    Changes to:
  • predictive1
  • predictive2
  • address-validation-parsed
  • address-validation-unparsed
  • widget
  • Lot/DP
  • Administrative Boundaries
      • Widget:
    • Input: None
    • Output: None
    • Behaviour: User can customise widget to search and return data from GNAF, PAF, LOT/DP and Administrative Boundaries data sets
      User can also configure the widget to search a list of states and the number of addresses returned between 1 and 10 inclusive

      Predictive1:
    • Input: The addition of 2 new optional parameters: stateTerritory, maxNumberResults
    • Output: Up to 10 results instead of a hard limit of 5
    • Behaviour: None

      Predictive2:
    • Input: None
    • Output: Addition of request_timestamp, request_date,
      renaming of data.meshblock to data.properties.abs.mb_2016_code,
      renaming of data.SA1 to data.properties.abs.sa1_2016_code,
      renaming of data.properties.complexStreetNumber1 to data.properties.streetNumber1,
      renaming of data.properties.complexStreetNumber2 to data.properties.streetNumber2,
      renaming of data.properties.Cad_ID to data.properties.cadastralIdentifier ,
      renaming of data.properties.site_name to data.properties.siteName,
      renaming of data.properties.lot_Identifier to data.properties.lotIdentifier
    • Behaviour: Function no longer returns 204 status codes. Now if an id isn’t found, a 404 code with appropriate message is returned.

      Address-Validation-parsed:
    • Input: Parsed to be removed from documentation but not from code. Variable does not affect output.
    • Output: Addition of request_timestamp, request_date,
      renaming of data.meshblock to data.properties.abs.mb_2016_code,
      renaming of data.SA1 to data.properties.abs.sa1_2016_code
      addition of matchQualityPercentageDescription, addressIdentifier, geoType and matchCertainty to response
    • Behaviour: Function no longer returns 204 status codes.
      Now if an error occurs or an address isn’t found, the appropriate 404 code with message is returned.

      Address-Validation-unparsed:
    • Input: Parsed to be removed from documentation but not from code. Variable does not affect output.
    • Output: Addition of request_timestamp, request_date,
      renaming of data.meshblock to data.properties.abs.mb_2016_code,
      renaming of data.SA1 to data.properties.abs.sa1_2016_code
      addition of matchQualityPercentageDescription, addressIdentifier, geoType and matchCertainty to response
    • Behaviour: Function no longer returns 204 status codes.
      Now if an error occurs or an address isn’t found a 404 code with appropriate message is returned
      Lot/DP:
    • Input: Geocode (in WGS or GDA94)
    • Output: Data object containing a list of lots associated with a property id
    • Behaviour:Lot/DP is only available for NSW addresses and requests data from a NSW Spatial Services data endpoint.

      Administrative Boundaries:
    • Input: Geocode (in WGS or GDA94)
    • Output: JSON object containing information about Australian Bureau of Statistics, LGA, State Electoral and Commonwealth administrative juristictions
    • Behaviour:Administrative Boundaries takes a geocode and searches a national dataset for a set of administative boundaries pertinent to that geocode