Query place searches are not case sensitive and are executed by matching search criteria against our Address Location Manager database, using either:
The order:
1. Road Name
2. Suburb
3. City/Town***
4. Level Number
5. Location descriptor.
Or, one of the address identifiers:
Place id TUI ID PLSAM.
***The query will search query both City and TerritorialAuthority name, as they may have the same value or, in some cases, an address record will not have an associated town name.
Pattern Matching (streetAlphaNumeric)
Pattern matching is used to search against values entered in the BIF Structured Address streetAlphaNumeric field. The following tables describe how pattern matching works.
IFSTREETALPHANUMERIC THEN... CONTAINS... |
THEN |
---|
"/" and no "-" characters, e.g. 1A/23. |
1. characters before the "/" are treated as a string and used as the flat number
2. contiguous numbers following the "/" are used as the first portion of the street number
3. the "/" character is then discarded. Example: streetAlphaNumeric 1A/23 becomes: Flat number 1A and street number 23.
|
"/" and "-" characters, e.g. 1A/23-27. |
1. characters before the "/" are treated as a string and used as the flat number
2. contiguous numbers between the "/" and before the "- " are used as the first portion of the street number
3. contiguous numbers following the "-" are used as the last portion of the streetnumber
4. the "/" and "-" characters are then discarded.
Example:
streetAlphaNumeric 1A/23-27 becomes: Flat number 1A, the first portion of the street number 23 and the last portion of the street number 27
|
"-" and no "/" characters, e.g. 23-27. |
1. contiguous numbers before the "-" are used as the first portion of the streetnumber
2. contiguous numbers following the "-" are used as the last portion of the street number Version '151201114324', printed from https://customer.chorus.co.nz/web-services on March 28 2018.
3. the "-" character is then discarded.
Example:
streetAlphaNumeric 23-27 becomes The first portion of the street number 23 and the last portion of street number 27.
|
"/" and a letter anywhere after the "/" character, e.g. 1A/23A. |
letters following the number after the "/" are used as the street number suffix.
Example:
streetAlphaNumeric 1A/23A becomes: Flat number 1A, the first portion of the street number 23 and street number suffixA.
|
a letter and no "/" character, e.g. 23B. |
1. contiguous numbers are used as the first portion of the street number
2. letters following the numbers are used as the street number suffix.
Example:
streetAlphaNumeric 23B becomes: The first portion of the street number 23 and street number suffix B.
|
a number with no "/", "-" or characters, e.g. 23. |
contiguous numbers are used as the first portion of the street number.
Example:
streetAlphaNumeric 23 becomes: The first portion of the street number 23.
|
Alternative Road and Alias Suburb Searches
We will always return our primary street/road name and suburb name, regardless of whether the primary or alternative names have been provided in the search.
This means that the address returned in the response may appear to be different from the one requested the search criteria.
Example:
The search criteria:
1 Smith, Ohawe.
Returns:
Place id: 102002584
1 Kingsford Smith Drive, Hawera.
The attached document demonstrates the 30 road and suburb search combinations, for which we return 1 Kingsford Smith Drive, Hawera.
Alternative Road and Alias Suburb Search Results [PDF, 65kB]
Exact Match Searches
The following table shows the elements used for exact match searches. The web service will perform a first level search if an exact match is not found it will perform a second level search.
CORELOGIC FIELD |
BIF STRUCTURED ADDRESSFIELD |
MATCH IS SUPPLIED |
CAN BE NULL |
NOTES |
---|
streetNrFirst |
streetAlphaNumeric - see Pattern Matching |
Yes (First level match) |
No |
Must be supplied. |
streetNrLast |
streetAlphaNumeric - see Pattern Matching |
Yes (First level match) |
Yes |
Required if the address has a range, e.g. 23-31. |
streetNrFirstSuffix |
streetAlphaNumeric - see Pattern Matching |
Yes (First level match) |
Yes |
Required if the address number has an alpha suffix, e.g. 23A. |
unitAlphaNumeric |
unitAlphaNumeric |
Yes (First level match) |
Yes |
Required if an address has a subunit, e.g. Flat 2/23. |
floor |
floor |
If supplied used in Secondary level Match |
Yes |
Required for multi-storey buildings. |
locationDescriptor |
locationDescriptor |
If supplied used in Secondary level Match |
Yes |
If a location descriptor exists in the database it will be returned with first level exact match results.
If it is included in the search criteria it will only be used for second-level searching.
|
streetName |
streetName |
Yes (First level match) |
No |
Must be supplied. |
streetType |
streetSuffix |
Yes (First level match) |
Yes |
If a road has a type it must be supplied, road names that do not have a road type include SH 1, Broadway, etc. |
roadNameSuffix |
|
Yes (First level match) |
Yes |
If a road name has a suffix i.e. descriptor after the road name type then it must be supplied otherwise an incorrect match can occur. |
suburb |
suburb |
Yes (First level match) |
No |
Must be supplied. |
town |
town |
Yes (First level match) |
No |
Must be supplied. |
postcode |
postcode |
Yes (First level match) |
No |
Must be supplied. |