Method:
DataTools.Capture.Address.Predictive.Gnaf.RetrieveAddress
You can use this method to retrieve full address details from the Australian GNAF data for record IDs prefixed with 'Gnaf'.
Test:
Input Parameters:
Output Fields:
| Field | Description |
| AddressSiteId | Address site Persistent Identifier |
| BuildingName | Building Name |
| AddressLine | Address Line |
| LotNumberPrefix | Lot number prefix |
| LotNumber | Lot number. Field length: five alphanumeric characters (AS4590.8.7) |
| LotNumberSuffix | Lot number suffix. Field length: two alphanumeric characters (AS4590.8.7) |
| UnitType | Specification of the type of a separately identifiable portion within a building/complex. Field Length: one to seven upper case alpha characters (AS4590.8.3) |
| UnitNumberPrefix | Flat/unit number prefix. Field length: two alphanumeric characters (AS4590.8.3) |
| UnitNumber | Flat/unit number. Field length: five numeric characters (AS4590.8.3) |
| UnitNumberSuffix | Flat/unit number suffix Field length: two alphanumeric characters (AS4590.8.3) |
| LevelType | Level type. Field length: two alpha characters (AS4590.8.4) |
| LevelNumberPrefix | Level number prefix. Field length: two alphanumeric characters (AS4590.8.4) |
| LevelNumber | Level number. Field length: three numeric characters (AS4590.8.4) |
| LevelNumberSuffix | Level number suffix. Field length: two numeric characters (AS4590.8.4) |
| StreetNumberPrefix1 | Prefix for the first (or only) number in range. Field length: two uppercase alphanumeric characters (AS4590.8.6) |
| StreetNumber1 | Identifies first (or only) street number in range. Field length: six numeric characters (AS4590.8.6) |
| StreetNumberSuffix1 | Suffix for the first (or only) number in range. Field length: two uppercase alphanumeric characters (AS4590.8.6) |
| StreetNumberPrefix2 | Prefix for the last number in range. Field length: two uppercase alphanumeric characters (AS4590.8.6) |
| StreetNumber2 | Prefix for the last number in range. Field length: two uppercase alphanumeric characters (AS4590.8.6) |
| StreetNumberSuffix2 | Suffix for the last number in range. Field length: two uppercase alphanumeric characters (AS4590.8.6) |
| StreetName | Street name. e.g. 'POPLAR' |
| StreetType | Street type. e.g. 'PLACE' |
| StreetSuffix | Street suffix. e.g. 'WEST' |
| StreetClassCode | Defines whether this street represents a confirmed or unconfirmed street. [Option Values] |
| StreetConfidence | Street confidence |
| StreetReliability | Always = 4. Spatial precision of the geocode expressed as number in the range, 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode) AS4590.8.16 [Option Values] |
| Locality | Locality name |
| State | State |
| Postcode | Postcodes are optional as prescribed by AS4819 and AS4590 |
| LocalityClassCode | Describes the class of locality (e.g. Gazetted, topographic feature etc.) [Option Values] |
| LocalityReliability | = 5 if suburb locality, else = 6. Spatial precision of the geocode expressed as number in the range, 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). AS4590.8.16 [Option Values] |
| LocationDescription | A general field to capture various references to address locations alongside another physical location. Field length: up to 45 alphanumeric characters (AS4590.8.14) |
| AliasOrPrinciple | An Alias or Principle address. [Option Values] |
| PrivateStreetInfo | Private street information. This is not broken up into name/type/suffix. Field length: up to 75 alphanumeric characters (AS4590.8.5) |
| LegalParcelId | Legal parcel id. Generic parcel id field derived from the PSMA Australia's CadLite parcel where available. |
| AddressConfidence | Reflects how many contributor databases this address appears in (0 = 1 database, 1 = 2 database etc.) |
| LevelGeocodedCode | Binary indicator of the level of geocoding this address has. e.g. 0 = 000 = (No geocode), 1 = 001 = (No Locality geocode, No Street geocode, Address geocode), etc. |
| PropertyId | Property persistent identifier referenced to relevant cadastral model. |
| GnafPropertyId | This field stores the G-NAF property_pid for the address. |
| PrimaryOrSecondary | A Primary or Secondary address. [Option Values] |
| DateAddressCreated | Date this record was created. Format YYYY-MM-DD |
| DateAddressLastModified | Date this record was last modified (not retired/recreated in line with ICSM standard). Format YYYY-MM-DD |
| DateAddressRetired | Date this record was retired. Format YYYY-MM-DD |
Supported Web Service API Interfaces:
Web Service Method: ProcessQueryStringRequest (REST)
Request Format: Url QueryString,
Protocols: HTTP GET, HTTPS GET,
Response Formats: JSON, XML*
Example Server Path: https://customname.datatoolscloud.net.au/KleberWebService/DtKleberService.svc
Sample QueryString Request:
/ProcessQueryStringRequest?Method=DataTools.Capture.Address.Predictive.Gnaf.RetrieveAddress&RecordId=&RequestId=&RequestKey=&DepartmentCode=
Sample JSON Response:
{
"DtResponse":{
"RequestId":"",
"ResultCount":"1",
"ErrorMessage":"",
"Result":[
{
"AddressSiteId":"",
"BuildingName":"",
"AddressLine":"",
"LotNumberPrefix":"",
"LotNumber":"",
"LotNumberSuffix":"",
"UnitType":"",
"UnitNumberPrefix":"",
"UnitNumber":"",
"UnitNumberSuffix":"",
"LevelType":"",
"LevelNumberPrefix":"",
"LevelNumber":"",
"LevelNumberSuffix":"",
"StreetNumberPrefix1":"",
"StreetNumber1":"",
"StreetNumberSuffix1":"",
"StreetNumberPrefix2":"",
"StreetNumber2":"",
"StreetNumberSuffix2":"",
"StreetName":"",
"StreetType":"",
"StreetSuffix":"",
"StreetClassCode":"",
"StreetConfidence":"",
"StreetReliability":"",
"Locality":"",
"State":"",
"Postcode":"",
"LocalityClassCode":"",
"LocalityReliability":"",
"LocationDescription":"",
"AliasOrPrinciple":"",
"PrivateStreetInfo":"",
"LegalParcelId":"",
"AddressConfidence":"",
"LevelGeocodedCode":"",
"PropertyId":"",
"GnafPropertyId":"",
"PrimaryOrSecondary":"",
"DateAddressCreated":"",
"DateAddressLastModified":"",
"DateAddressRetired":""
}
]
}
}
* Add the additional input parameter "OutputFormat=json" or "OutputFormat=xml" to change the response format from default.
* Add the additional input parameter "callback" to convert JSON responses to JSONP responses for across domains support.
CORS header included where callback is not defined.
Please Note:
Ensure you thoroughly test all the methods you are using and are happy with the results before going into production. DataTools is charged by the data suppliers for use of every method – therefore
ALL calls to any method will incur a COST. When you register DataTools provides you with free credit to help with development and trialling of the service. Once that credit is used you will need to purchase a monthly subscription and/or top up to continue using the service, even for development purposes. Please check the Method Pricing List for all current costs. DataTools does not warrant or guarantee the quality of the results returned and will not be held responsible for any costs incurred by using a method. Should you have any questions please contact your Sales representative or the Client Services team.