Australia Post Parcel Locker Plus Lookup

This page provides information about the HRA Restful API's 'similar-addresses' feature, which now includes functionality for searching and filtering Australia Post Parcel Locker Plus Data.

To complete the search requires the same API 'similar-addresses' that returns detailed information of the Parcel Locker Plus and existing datasets.

1. similar-addresses - Returns a list of valid Australia Post Asset data using partial or complete address information.

similar-addresses

This API enables users to retrieve a list of valid Australia Post Parcel Locker Plus data based on either complete or partial address information, including street address, locality name, or keywords such as Parcel Locker, Post office, and Street Posting Box.

Users can further refine their search by giving precedence to locality, state, postcode details to filter the data relevant to their input. Additionally, users can filter data by different address types, including Parcel Locker, Post Office, and Street Posting Box addresses. The available type names are integrated into the option description on the HRA demo page for user convenience.

Furthermore, the API allows for cross-country searches, enabling users to explore data sources from both Australia and New Zealand.

Resource

The port number is configurable, with the default ports being:

• Tomcat: 8080

POST http://localhost:8080/HRAWeb/hra/rest/au/address/similar-addresses

Request

Lookup addresses with AU Parcel Locker Plus (Aust Post Assets) (All: Parcel Locker, Offices, Shops).

required input field*

Name	Type	Example	Description
Payload
fullAddress*	string	10 High	partial/complete address information entered by end user. Input can include street address, locality name, or keywords such as Parcel Locker, Post office, and Street Posting Box.
state	string	NSW	Filters address response to state. Often used with validateFields option.
locality	string	Sydney CBD	Filters address response to locality. Often used with validateFields option.
postcode	string	2000	Filters address response to postcode. Often used with validateFields.
Options
source*	string	AUPOST	Within AU & NZ specifies the desired dataset for your use case. Options: AUS: "AUPAF", "GNAF", "AUPOST" NZ: "NZPAF", "NZAD", "CNAR"
top	integer	5 default 20	Maximum number of results returned from the lookup. "top" option set will evenly distribute the search across defined sources when "sources" and "moreSources" are set in the request.
caseType	string	TITLE default UP	Case type for the returned addresses and components. LOW = lowercase, UP = UPPERCASE, TITLE = Title Case
validateFields		["STATE","POSTCODE"]	Determines whether to filter the results based on the configured fields (i.e. [ "LOCALITY", "STATE", "POSTCODE"]). For example, if "validateFields" is ["STATE","POSTCODE] and the "payload" has "state" as "NSW" and postcode as "2747" it will only show the results from NSW 2747. The "state" field also support multiple values separated by "|", e.g. "NSW|VIC|QLD".
addressTypeFilter	string	["upl", "lpo", "cpa", "rp", "ra", "rspb", "cspb"]	Default all. Array of filters to be applied to the lookup results. Used to control which Australian Post asset data is available in serviceable network.
moreSources	string	["AUPOST", "NZAD"]	Looks up additional sources and combines results. Used in conjunction with source to expand address search. options: AUPAF, AUPOST, GNAF, NZPAF, NZAD, CNAR. Linktable cannot be accessed using moreSources. Please note that duplicated results can appear if searching from sources within one country, e.g. 'AUPAF' and 'GNAF'.
locale	enum	AU	Locale in which similar-addresses returns the addresses.Supports only "AU". When a locale is specified, the search is conducted within Australian data sources, including "AUPAF" and "GNAF."
baseSource	string	"GNAF" |"AUPAF" default baseSource "GNAF"	Used together with "locale" to enable linktable access. Specifies which data source is used as the base for the search result. Additional information from the other source (if available) is added to the addresses from the base result.

Understanding addressTypeFilter:

This filter enables granular filtering of the data types within Parcel Locker Plus data assets. Commonly these are filtered by Collection use cases - in that the end user is to collect mail or package from a location OR Sending use cases which is the location of Red/Yellow post boxes that are being posted.

Common Use Cases:

Collection Only: You need to set the "addressTypeFilter": "-rspb, -cspb". This searches everything except the sending use cases.

Sending Only: You need to set the "addressTypeFilter": "rspb, cspb". This searches only the sending use cases.

Parcel Locker Only: You need to set the "addressTypeFilter": "upl". This searches only Parcel Locker locations.

The addressTypeFilter are as detailed below:

addressTypeFilter Code	Description
UPL​	PARCEL LOCKER​
LPO​	LICENSED POST OFFICE​
PO​	POST OFFICE​
CPA​	COMMUNITY POSTAL AGENT​
RA​	RETAIL ANNEXE​
RP​	POSTSHOP​
POA​	POST OFFICE AGENCY​
PDEP​	DELIVERY ANNEX​
BC​	BUSINESS CENTRE​
RSPB​	RED STREET POSTING BOX​
CSPB​	COMBINED STREET POSTING BOX​

Response:

Find AU Parcel Locker Plus (Aust Post Assets) using the key words Parcel Locker, Post shop within a specific locality or postcode.

Request 1: All of Parcel Locker Plus (unfiltered based on fullAddress)

{
  "option":

{     "source": "AUPOST", "top":"5" }
,
  "payload":

{     "fullAddress": "Parcel Locker 3000"}
}

Response 1: Unfiltered based on fullAddress

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "360 Collins Street Parcel Locker, 360 Collins St, MELBOURNE VIC 3000",
            "addressLine1": "360 Collins St",
            "addressLine2": "MELBOURNE VIC 3000",
            "dpid": "45897528",
            "localityName": "MELBOURNE",
            "postcode": "3000",
            "buildingName1": "360 Collins Street Parcel Locker",
            "latitude": "-37.815998",
            "longitude": "144.962314",
            "id": "45897528_UPL",
            "attributes": {
                "address_line_1": "360 Collins St",
                "description": "07:00 - 19:00 Monday to Friday",
                "id": "45897528_UPL",
                "location_description": "Parcel Locker is located on level B1 (closed P/H)",
                "name": "360 Collins Street Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "452 Flinders Street Parcel Locker, 452 Flinders Street, MELBOURNE VIC 3000",
            "addressLine1": "452 Flinders Street",
            "addressLine2": "MELBOURNE VIC 3000",
            "dpid": "35165839",
            "localityName": "MELBOURNE",
            "postcode": "3000",
            "buildingName1": "452 Flinders Street Parcel Locker",
            "latitude": "-37.819302",
            "longitude": "144.958785",
            "id": "35165839_UPL",
            "attributes": {
                "address_line_1": "452 Flinders Street",
                "description": "Available Mon to Fri: 07:00AM - 07:00PM",
                "id": "35165839_UPL",
                "location_description": "Parcel Locker is located in the ground floor lobby oposite the lifts",
                "name": "452 Flinders Street Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "Melbourne Box Room Parcel Locker, 380 Bourke St, MELBOURNE VIC 3000",
            "addressLine1": "380 Bourke St",
            "addressLine2": "MELBOURNE VIC 3000",
            "dpid": "77153239",
            "localityName": "MELBOURNE",
            "postcode": "3000",
            "buildingName1": "Melbourne Box Room Parcel Locker",
            "latitude": "-37.814285",
            "longitude": "144.962325",
            "id": "77153239_UPL",
            "attributes": {
                "address_line_1": "380 Bourke St",
                "description": "Mon-Fri: 5:00 AM to 7:00 PM  Sat: 10:00 AM to 2:00 PM",
                "id": "77153239_UPL",
                "location_description": "Parcel Locker is located in the boxroom",
                "name": "Melbourne Box Room Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "RMIT Library Parcel Locker, 124 La Trobe Street, MELBOURNE VIC 3000",
            "addressLine1": "124 La Trobe Street",
            "addressLine2": "MELBOURNE VIC 3000",
            "dpid": "70135061",
            "localityName": "MELBOURNE",
            "postcode": "3000",
            "buildingName1": "RMIT Library Parcel Locker",
            "latitude": "-37.808188",
            "longitude": "144.964078",
            "id": "70135061_UPL",
            "attributes": {
                "address_line_1": "124 La Trobe Street",
                "description": "Available 24x7",
                "id": "70135061_UPL",
                "location_description": "Adjacent to the returned books drop box  accessible from Bowen Street",
                "name": "RMIT Library Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "Melbourne Bourke Street Parcel Locker, 15 Southern Cross Lane, MELBOURNE VIC 3000",
            "addressLine1": "15 Southern Cross Lane",
            "addressLine2": "MELBOURNE VIC 3000",
            "dpid": "95803441",
            "localityName": "MELBOURNE",
            "postcode": "3000",
            "buildingName1": "Melbourne Bourke Street Parcel Locker",
            "latitude": "-37.812935",
            "longitude": "144.969951",
            "id": "95803441_UPL",
            "attributes": {
                "address_line_1": "15 Southern Cross Lane",
                "description": "Mon-Fri: 6:00 AM to 5:00 PM",
                "id": "95803441_UPL",
                "location_description": "Parcel Locker is in the 24/7 area of Melbourne Bourke Street Post Shop",
                "name": "Melbourne Bourke Street Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        }
    ]
}

Request 2: Lookup Post Office Assets (unfiltered based on fullAddress)

{
  "option":

{     "source": "AUPOST", "top":"2"}
,

  "payload":

{     "fullAddress": "post shop North Sydney"}
}

Response 2: Post Office address from North Sydney

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "NORTH SYDNEY POST SHOP, 92 Pacific Highway, NORTH SYDNEY NSW 2060",
            "addressLine1": "92 Pacific Highway",
            "addressLine2": "NORTH SYDNEY NSW 2060",
            "dpid": "74042589",
            "localityName": "NORTH SYDNEY",
            "postcode": "2060",
            "buildingName1": "NORTH SYDNEY POST SHOP",
            "latitude": "-33.838593",
            "longitude": "151.206348",
            "id": "241613_PO",
            "attributes": {
                "address_line_1": "92 Pacific Highway",
                "description": "POSTSHOP",
                "id": "241613_PO",
                "name": "NORTH SYDNEY POST SHOP",
                "record_type": "po",
                "type": "RP"
            }
        },
        {
            "fullAddress": "Australian Catholic Uni N Sydney Pcl Lkr, 33 Berry St, NORTH SYDNEY NSW 2060",
            "addressLine1": "33 Berry St",
            "addressLine2": "NORTH SYDNEY NSW 2060",
            "dpid": "88136707",
            "localityName": "NORTH SYDNEY",
            "postcode": "2060",
            "buildingName1": "Australian Catholic Uni N Sydney Pcl Lkr",
            "latitude": "-33.837048",
            "longitude": "151.205566",
            "id": "88136707_UPL",
            "attributes": {
                "address_line_1": "33 Berry St",
                "description": "Available 24x7",
                "id": "88136707_UPL",
                "location_description": "Rear Entry to 33 Berry Street  opposite ACU track",
                "name": "Australian Catholic Uni N Sydney Pcl Lkr",
                "record_type": "upl",
                "type": "UPL"
            }
        }
    ]
}

Our API is highly configurable to suit your use case. Here are some fine-tuned samples to filter out specific AU Parcel Locker Plus (Aust Post Assets) using the address type filters.

Request 3 and Request 4 demonstrate the capability of performing search using locality input, with further refinement available through the use of the addressTypeFilter parameter.

Kingswood is a place with following Aust Post Assets.

1. Kingswood NSW 2747(1-RP)

2. Kingswood NSW 2340(1-CPA)

3. Kingswood SA 5062(Red Street Posting Box-4records)

4. Kingswood NSW 2747(Red Street Posting Box-3records)

5. Kingswood NSW 2747(Combined Street Posting Box-1record)

Request 3: Collection Points Only with Postcode level Geo Filtering

State filter is not required but shown as state filtering is available.

{
  "option":
{     "source": "AUPOST","top":"4","addressTypeFilters": [ "-RSPB","-CSPB"],"validateFields":["STATE","POSTCODE"]   }
,
  "payload":
{     "fullAddress": "Kingswood", "state":"NSW", "postcode":"2747"   }
}

Response 3: Shows the Collection Points Only from NSW 2747

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "KINGSWOOD POST SHOP, 11 Bringelly Road, KINGSWOOD NSW 2747",
            "addressLine1": "11 Bringelly Road",
            "addressLine2": "KINGSWOOD NSW 2747",
            "dpid": "36986297",
            "localityName": "KINGSWOOD",
            "postcode": "2747",
            "buildingName1": "KINGSWOOD POST SHOP",
            "latitude": "-33.760639",
            "longitude": "150.719810",
            "id": "237040_PO",
            "attributes": {
                "address_line_1": "11 Bringelly Road",
                "description": "POSTSHOP",
                "id": "237040_PO",
                "name": "KINGSWOOD POST SHOP",
                "record_type": "po",
                "type": "RP"
            }
        }
    ]
}

Request 4: Sending Points Only with Postcode level Geo Filtering

{
  "option":
{     "source": "AUPOST","top":"4","addressTypeFilters": [ "RSPB","CSPB"],"validateFields":["STATE","POSTCODE"]   }
,
  "payload":
{     "fullAddress": "Kingswood", "postcode":"2747" }
}

Response 4: Includes only sending use cases.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "Red Street Posting Box, 2 Richmond Road, KINGSWOOD NSW 2747",
            "addressLine1": "2 Richmond Road",
            "addressLine2": "KINGSWOOD NSW 2747",
            "localityName": "KINGSWOOD",
            "postcode": "2747",
            "buildingName1": "Red Street Posting Box",
            "latitude": "-33.758145",
            "longitude": "150.720823",
            "id": "RED0005682",
            "attributes": {
                "address_line_1": "2 Richmond Road",
                "id": "RED0005682",
                "name": "Red Street Posting Box",
                "record_type": "spb",
                "type": "RSPB"
            }
        },
        {
            "fullAddress": "Combined Street Posting Box, 9 Bringelly Road, KINGSWOOD NSW 2747",
            "addressLine1": "9 Bringelly Road",
            "addressLine2": "KINGSWOOD NSW 2747",
            "localityName": "KINGSWOOD",
            "postcode": "2747",
            "buildingName1": "Combined Street Posting Box",
            "latitude": "-33.760877",
            "longitude": "150.720203",
            "id": "RED0005670",
            "attributes": {
                "address_line_1": "9 Bringelly Road",
                "id": "RED0005670",
                "name": "Combined Street Posting Box",
                "record_type": "spb",
                "type": "CSPB"
            }
        },
        {
            "fullAddress": "Red Street Posting Box, 61 Derby Streeet, KINGSWOOD NSW 2747",
            "addressLine1": "61 Derby Streeet",
            "addressLine2": "KINGSWOOD NSW 2747",
            "localityName": "KINGSWOOD",
            "postcode": "2747",
            "buildingName1": "Red Street Posting Box",
            "latitude": "-33.760562",
            "longitude": "150.712696",
            "id": "RED0005680",
            "attributes": {
                "address_line_1": "61 Derby Streeet",
                "id": "RED0005680",
                "name": "Red Street Posting Box",
                "record_type": "spb",
                "type": "RSPB"
            }
        },
        {
            "fullAddress": "Red Street Posting Box, 42 Bringelly Road, KINGSWOOD NSW 2747",
            "addressLine1": "42 Bringelly Road",
            "addressLine2": "KINGSWOOD NSW 2747",
            "localityName": "KINGSWOOD",
            "postcode": "2747",
            "buildingName1": "Red Street Posting Box",
            "latitude": "-33.764152",
            "longitude": "150.719700",
            "id": "RED0005671",
            "attributes": {
                "address_line_1": "42 Bringelly Road",
                "id": "RED0005671",
                "name": "Red Street Posting Box",
                "record_type": "spb",
                "type": "RSPB"
            }
        }
    ]
}

Request 5: Parcel Locker Plus Only with State Filter

{
  "option":
{     "source": "AUPOST","top":"5","addressTypeFilters": [ "UPL"],"validateFields":["STATE"]   }
,
  "payload":
{     "fullAddress": "syd", "state":"NSW|QLD|VIC" }
}

Response 5: Includes Parcel Locker addresses only from the states specified in the request.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "Brunswick Parcel Locker, 415 Sydney Road, BRUNSWICK VIC 3056",
            "addressLine1": "415 Sydney Road",
            "addressLine2": "BRUNSWICK VIC 3056",
            "dpid": "72061925",
            "localityName": "BRUNSWICK",
            "postcode": "3056",
            "buildingName1": "Brunswick Parcel Locker",
            "latitude": "-37.767596",
            "longitude": "144.961973",
            "id": "72061925_UPL",
            "attributes": {
                "address_line_1": "415 Sydney Road",
                "description": "Available 24/7",
                "id": "72061925_UPL",
                "location_description": "Parcel Locker is located in the PO Box suite",
                "name": "Brunswick Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "Coburg North BP Parcel Locker, 989 Sydney Road, COBURG NORTH VIC 3058",
            "addressLine1": "989 Sydney Road",
            "addressLine2": "COBURG NORTH VIC 3058",
            "dpid": "37085722",
            "localityName": "COBURG NORTH",
            "postcode": "3058",
            "buildingName1": "Coburg North BP Parcel Locker",
            "latitude": "-37.725350",
            "longitude": "144.963368",
            "id": "37085722_UPL",
            "attributes": {
                "address_line_1": "989 Sydney Road",
                "description": "Available 24/7",
                "id": "37085722_UPL",
                "location_description": "Parcel Locker is located next to the ice box",
                "name": "Coburg North BP Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "Mackay Parcel Locker, Shop 1 65-69 Sydney Street, MACKAY QLD 4740",
            "addressLine1": "Shop 1 65-69 Sydney Street",
            "addressLine2": "MACKAY QLD 4740",
            "dpid": "75199764",
            "localityName": "MACKAY",
            "postcode": "4740",
            "buildingName1": "Mackay Parcel Locker",
            "latitude": "-21.143151",
            "longitude": "149.187066",
            "id": "75199764_UPL",
            "attributes": {
                "address_line_1": "Shop 1 65-69 Sydney Street",
                "description": "Available 24/7",
                "id": "75199764_UPL",
                "location_description": "Parcel Locker is located on the right hand side adjacent to the PO Box lobby",
                "name": "Mackay Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "383 Kent Street Parcel Locker, 383 Kent Street, SYDNEY NSW 2000",
            "addressLine1": "383 Kent Street",
            "addressLine2": "SYDNEY NSW 2000",
            "dpid": "48057952",
            "localityName": "SYDNEY",
            "postcode": "2000",
            "buildingName1": "383 Kent Street Parcel Locker",
            "latitude": "-33.870246",
            "longitude": "151.203890",
            "id": "48057952_UPL",
            "attributes": {
                "address_line_1": "383 Kent Street",
                "description": "Available 24/7",
                "id": "48057952_UPL",
                "location_description": "Parcel Locker is located next to  the Wilson Parking entrance off Sussex Street",
                "name": "383 Kent Street Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "Market Street Parcel Locker, 1 Market Street, SYDNEY NSW 2000",
            "addressLine1": "1 Market Street",
            "addressLine2": "SYDNEY NSW 2000",
            "dpid": "60240490",
            "localityName": "SYDNEY",
            "postcode": "2000",
            "buildingName1": "Market Street Parcel Locker",
            "latitude": "-33.871177",
            "longitude": "151.204381",
            "id": "60240490_UPL",
            "attributes": {
                "address_line_1": "1 Market Street",
                "description": "Available 24/7",
                "id": "60240490_UPL",
                "location_description": "Parcel Locker is located in the walkway leadng to the Shelbourne Hotel",
                "name": "Market Street Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        }
    ]
}

Using MoreSources and Parcel Locker Plus

Request 6 and Request 7 demonstrates searches across various sources by utilizing moreSources, which includes cross-country searches.

primary source: option "source"

additional source: option "moreSources"

Please be aware that the "top" option set will evenly distribute the search across the defined sources. For instance, if the top 6 is specified, then two records will be sourced from each source, including both the primary source and additional sources. It's important to note that records from the primary source will be given priority and listed at the top of the results.

Request 6: Request to demonstrate search against various sources that belong to the same country AUSTRALIA.

{
  "option":

{     "source": "AUPOST", "top":"5","moreSources":["AUPAF","GNAF"]  }
,

  "payload":

{     "fullAddress": "48 Spains Lane,kingswood NSW 2340"   }
}

Response 6: Response includes records from primary and additional sources.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "KINGSWOOD ESTATE CPA, Kingswood Country Store, 42-48 Spains Lane, KINGSWOOD NSW 2340",
            "addressLine1": "Kingswood Country Store, 42-48 Spains Lane",
            "addressLine2": "KINGSWOOD NSW 2340",
            "dpid": "64647560",
            "localityName": "KINGSWOOD",
            "postcode": "2340",
            "buildingName1": "KINGSWOOD ESTATE CPA",
            "latitude": "-31.164740",
            "longitude": "150.914457",
            "id": "276939_PO",
            "attributes": {
                "address_line_1": "Kingswood Country Store",
                "address_line_2": "42-48 Spains Lane",
                "description": "COMMUNITY POSTAL AGENT",
                "id": "276939_PO",
                "name": "KINGSWOOD ESTATE CPA",
                "record_type": "po",
                "type": "CPA"
            }
        },
        {
            "fullAddress": "42-48 SPAINS LANE, KINGSWOOD NSW 2340",
            "addressLine1": "42-48 SPAINS LANE",
            "addressLine2": "KINGSWOOD NSW 2340",
            "dpid": "64647560",
            "pafPosition": "SINGLE",
            "localityName": "KINGSWOOD",
            "postcode": "2340",
            "state": "NSW",
            "streetName": "SPAINS",
            "streetType": "LANE",
            "houseNumber1": "42",
            "houseNumber2": "48",
            "attributes": {
                "advertising_mail_ind": "Y",
                "deliver_mail_ind": "Y",
                "geo_centroid_confidence": "2",
                "geo_centroid_feature_code": "centroid",
                "geo_centroid_feature_label": "Centroid",
                "geo_centroid_latitude": "-31.164531",
                "geo_centroid_longitude": "150.910602",
                "non_residential_ind": "N",
                "residential_ind": "Y"
            }
        },
        {
            "fullAddress": "LOT 611 42-48 SPAINS LANE, KINGSWOOD NSW 2340",
            "addressLine1": "LOT 611 42-48 SPAINS LANE",
            "addressLine2": "KINGSWOOD NSW 2340",
            "localityName": "KINGSWOOD",
            "postcode": "2340",
            "state": "NSW",
            "streetName": "SPAINS",
            "streetType": "LANE",
            "houseNumber1": "42",
            "houseNumber2": "48",
            "lotNumber": "611",
            "gnafLocalityPID": "loc917a937b04f6",
            "gnafGroupPID": "NSW2941076",
            "gnafPointPID": "GANSW716357157",
            "gnafPID": "GANSW716357157",
            "gnafPosition": "SINGLE",
            "gnafGeocodeLevel": "7",
            "gnafReliability": "2",
            "gnafGeocodeConfidence": "2",
            "parcelId": "611/1010985",
            "latitude": "-31.16472030",
            "longitude": "150.91420557",
            "attributes": {
                "MeshBlockID2016": "10764981000",
                "MeshBlockID2021": "10764981000",
                "area_sqkm": "31.271",
                "ced_code": "130",
                "ced_name": "New England",
                "eo_national_decile": "5",
                "eo_national_percentile": "46",
                "eo_national_rank": "25188",
                "eo_score": "987",
                "eo_state_decile": "5",
                "eo_state_percentile": "44",
                "eo_state_rank": "7727",
                "er_national_decile": "8",
                "er_national_percentile": "78",
                "er_national_rank": "42464",
                "er_score": "1075",
                "er_state_decile": "8",
                "er_state_percentile": "75",
                "er_state_rank": "13046",
                "gcc_sa_code": "1RNSW",
                "gcc_sa_name": "Rest of NSW",
                "is_principal": "P",
                "lga_code": "17310",
                "lga_name": "Tamworth Regional (A)",
                "ra_code": "11",
                "ra_name": "Inner Regional Australia",
                "rsead_national_decile": "8",
                "rsead_national_percentile": "77",
                "rsead_national_rank": "41891",
                "rsead_score": "1074",
                "rsead_state_decile": "8",
                "rsead_state_percentile": "74",
                "rsead_state_rank": "12962",
                "rsed_national_decile": "7",
                "rsed_national_percentile": "61",
                "rsed_national_rank": "33247",
                "rsed_score": "1033",
                "rsed_state_decile": "6",
                "rsed_state_percentile": "58",
                "rsed_state_rank": "10127",
                "sa1_code_7d": "1120210",
                "sa1_code_main": "11004120210",
                "sa1_population": "680",
                "sa2_code_5d": "11202",
                "sa2_code_main": "110041202",
                "sa2_name": "Tamworth - East",
                "sa3_code": "11004",
                "sa3_name": "Tamworth - Gunnedah",
                "sa4_code": "110",
                "sa4_name": "New England and North West",
                "sed_code": "10081",
                "sed_name": "Tamworth",
                "state_code": "1",
                "state_name": "New South Wales"
            },
            "meshblockId": "10764981000"
        },
        {
            "fullAddress": "LOT 48 58-68 SPAINS LANE, KINGSWOOD NSW 2340",
            "addressLine1": "LOT 48 58-68 SPAINS LANE",
            "addressLine2": "KINGSWOOD NSW 2340",
            "localityName": "KINGSWOOD",
            "postcode": "2340",
            "state": "NSW",
            "streetName": "SPAINS",
            "streetType": "LANE",
            "houseNumber1": "58",
            "houseNumber2": "68",
            "lotNumber": "48",
            "gnafLocalityPID": "loc917a937b04f6",
            "gnafGroupPID": "NSW2941076",
            "gnafPointPID": "GANSW716357159",
            "gnafPID": "GANSW716357159",
            "gnafPosition": "SINGLE",
            "gnafGeocodeLevel": "7",
            "gnafReliability": "2",
            "gnafGeocodeConfidence": "1",
            "parcelId": "48/258485",
            "latitude": "-31.16426827",
            "longitude": "150.91226537",
            "attributes": {
                "MeshBlockID2016": "10764910000",
                "MeshBlockID2021": "10764910000",
                "area_sqkm": "3.6541",
                "ced_code": "130",
                "ced_name": "New England",
                "eo_national_decile": "6",
                "eo_national_percentile": "60",
                "eo_national_rank": "32566",
                "eo_score": "1024",
                "eo_state_decile": "6",
                "eo_state_percentile": "57",
                "eo_state_rank": "9908",
                "er_national_decile": "10",
                "er_national_percentile": "92",
                "er_national_rank": "50294",
                "er_score": "1125",
                "er_state_decile": "9",
                "er_state_percentile": "88",
                "er_state_rank": "15474",
                "gcc_sa_code": "1RNSW",
                "gcc_sa_name": "Rest of NSW",
                "is_principal": "P",
                "lga_code": "17310",
                "lga_name": "Tamworth Regional (A)",
                "ra_code": "11",
                "ra_name": "Inner Regional Australia",
                "rsead_national_decile": "9",
                "rsead_national_percentile": "83",
                "rsead_national_rank": "45518",
                "rsead_score": "1088",
                "rsead_state_decile": "8",
                "rsead_state_percentile": "80",
                "rsead_state_rank": "14005",
                "rsed_national_decile": "7",
                "rsed_national_percentile": "68",
                "rsed_national_rank": "37180",
                "rsed_score": "1052",
                "rsed_state_decile": "7",
                "rsed_state_percentile": "64",
                "rsed_state_rank": "11230",
                "sa1_code_7d": "1120208",
                "sa1_code_main": "11004120208",
                "sa1_population": "376",
                "sa2_code_5d": "11202",
                "sa2_code_main": "110041202",
                "sa2_name": "Tamworth - East",
                "sa3_code": "11004",
                "sa3_name": "Tamworth - Gunnedah",
                "sa4_code": "110",
                "sa4_name": "New England and North West",
                "sed_code": "10081",
                "sed_name": "Tamworth",
                "state_code": "1",
                "state_name": "New South Wales"
            },
            "meshblockId": "10764910000"
        }
    ]
}

Request 7: Request to demonstrate search against cross-country search against AUSTRALIA and NEW_ZEALAND

{
  "option":

{    "source":"NZAD",  "top":6, "moreSources":["AUPOST","GNAF"]  }
,
  "payload":

{     "fullAddress": "6 George st"}
}

Response 7: Response includes records from primary and additional sources.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "6 GEORGE STREET, RIVERHEAD 0820",
            "addressLine1": "6 GEORGE STREET",
            "addressLine2": "RIVERHEAD 0820",
            "dpid": "2976308",
            "postcode": "0820",
            "streetName": "GEORGE",
            "streetType": "STREET",
            "houseNumber1": "6",
            "townCityName": "RIVERHEAD",
            "xCoordinate": "1742419.62888764",
            "yCoordinate": "5930933.09700348",
            "parcelId": "4859854",
            "latitude": "-36.75667481782947",
            "longitude": "174.59552200462932",
            "attributes": {
                "address_line1": "6 GEORGE STREET",
                "address_line2": "RIVERHEAD  0820",
                "address_type": "URBAN",
                "delivered_to": "N",
                "regional_council_id": "2",
                "regional_council_name": "AUCKLAND REGION",
                "source": "NZPOST",
                "ta_id": "76",
                "ta_name": "AUCKLAND"
            },
            "meshblockId": "213501"
        },
        {
            "fullAddress": "6 GEORGE STREET, WAIUKU 2123",
            "addressLine1": "6 GEORGE STREET",
            "addressLine2": "WAIUKU 2123",
            "dpid": "1397624",
            "postcode": "2123",
            "streetName": "GEORGE",
            "streetType": "STREET",
            "houseNumber1": "6",
            "townCityName": "WAIUKU",
            "xCoordinate": "1753559.29029849",
            "yCoordinate": "5875383.36715604",
            "parcelId": "5007185",
            "latitude": "-37.25545712018118",
            "longitude": "174.73158862289498",
            "attributes": {
                "address_line1": "6 GEORGE STREET",
                "address_line2": "WAIUKU  2123",
                "address_type": "URBAN",
                "delivered_to": "Y",
                "regional_council_id": "2",
                "regional_council_name": "AUCKLAND REGION",
                "source": "NZPOST",
                "ta_id": "76",
                "ta_name": "AUCKLAND"
            },
            "meshblockId": "4002782"
        },
        {
            "fullAddress": "TINTENBAR LPO, 6 George Street, TINTENBAR NSW 2478",
            "addressLine1": "6 George Street",
            "addressLine2": "TINTENBAR NSW 2478",
            "dpid": "51378313",
            "localityName": "TINTENBAR",
            "postcode": "2478",
            "buildingName1": "TINTENBAR LPO",
            "latitude": "-28.797110",
            "longitude": "153.512549",
            "id": "249826_PO",
            "attributes": {
                "address_line_1": "6 George Street",
                "description": "LICENSED POST OFFICE",
                "id": "249826_PO",
                "name": "TINTENBAR LPO",
                "record_type": "po",
                "type": "LPO"
            }
        },
        {
            "fullAddress": "Red Street Posting Box, 6 George Street, TINTENBAR NSW 2478",
            "addressLine1": "6 George Street",
            "addressLine2": "TINTENBAR NSW 2478",
            "localityName": "TINTENBAR",
            "postcode": "2478",
            "buildingName1": "Red Street Posting Box",
            "latitude": "-28.796979",
            "longitude": "153.513056",
            "id": "RED0004660",
            "attributes": {
                "address_line_1": "6 George Street",
                "id": "RED0004660",
                "name": "Red Street Posting Box",
                "record_type": "spb",
                "type": "RSPB"
            }
        },
        {
            "fullAddress": "6 GEORGE STREET, SOUTH PAMBULA NSW 2549",
            "addressLine1": "6 GEORGE STREET",
            "addressLine2": "SOUTH PAMBULA NSW 2549",
            "localityName": "SOUTH PAMBULA",
            "postcode": "2549",
            "state": "NSW",
            "streetName": "GEORGE",
            "streetType": "STREET",
            "houseNumber1": "6",
            "gnafLocalityPID": "locf5d6b06a242c",
            "gnafGroupPID": "NSW354238",
            "gnafPointPID": "GANSW719835722",
            "gnafPID": "GANSW719835722",
            "gnafPosition": "SINGLE",
            "gnafGeocodeLevel": "6",
            "gnafReliability": "4",
            "gnafGeocodeConfidence": "0",
            "latitude": "-36.94557139",
            "longitude": "149.86026410",
            "attributes": {
                "MeshBlockID2016": "10075390000",
                "MeshBlockID2021": "10075390000",
                "area_sqkm": "5.1662",
                "ced_code": "113",
                "ced_name": "Eden-Monaro",
                "eo_national_decile": "3",
                "eo_national_percentile": "22",
                "eo_national_rank": "12017",
                "eo_score": "919",
                "eo_state_decile": "3",
                "eo_state_percentile": "22",
                "eo_state_rank": "3746",
                "er_national_decile": "6",
                "er_national_percentile": "54",
                "er_national_rank": "29692",
                "er_score": "1018",
                "er_state_decile": "6",
                "er_state_percentile": "53",
                "er_state_rank": "9337",
                "gcc_sa_code": "1RNSW",
                "gcc_sa_name": "Rest of NSW",
                "is_principal": "P",
                "lga_code": "10550",
                "lga_name": "Bega Valley (A)",
                "ra_code": "12",
                "ra_name": "Outer Regional Australia",
                "rsead_national_decile": "4",
                "rsead_national_percentile": "36",
                "rsead_national_rank": "19531",
                "rsead_score": "984",
                "rsead_state_decile": "4",
                "rsead_state_percentile": "38",
                "rsead_state_rank": "6593",
                "rsed_national_decile": "3",
                "rsed_national_percentile": "26",
                "rsed_national_rank": "13847",
                "rsed_score": "938",
                "rsed_state_decile": "3",
                "rsed_state_percentile": "26",
                "rsed_state_rank": "4461",
                "sa1_code_7d": "1102513",
                "sa1_code_main": "10104102513",
                "sa1_population": "465",
                "sa2_code_5d": "11025",
                "sa2_code_main": "101041025",
                "sa2_name": "Merimbula - Tura Beach",
                "sa3_code": "10104",
                "sa3_name": "South Coast",
                "sa4_code": "101",
                "sa4_name": "Capital Region",
                "sed_code": "10009",
                "sed_name": "Bega",
                "state_code": "1",
                "state_name": "New South Wales"
            },
            "meshblockId": "10075390000"
        },
        {
            "fullAddress": "6 GEORGE STREET, SOUTH BRIGHTON SA 5048",
            "addressLine1": "6 GEORGE STREET",
            "addressLine2": "SOUTH BRIGHTON SA 5048",
            "localityName": "SOUTH BRIGHTON",
            "postcode": "5048",
            "state": "SA",
            "streetName": "GEORGE",
            "streetType": "STREET",
            "houseNumber1": "6",
            "gnafLocalityPID": "loc7c18a996de63",
            "gnafGroupPID": "SA564831",
            "gnafPointPID": "GASA_719772880",
            "gnafPID": "GASA_719772880",
            "gnafPosition": "SINGLE",
            "gnafGeocodeLevel": "7",
            "gnafReliability": "2",
            "gnafGeocodeConfidence": "2",
            "parcelId": "D/117068/A/2",
            "latitude": "-35.02468744",
            "longitude": "138.52281270",
            "attributes": {
                "MeshBlockID2016": "40059080000",
                "MeshBlockID2021": "40059080000",
                "area_sqkm": "0.1183",
                "ced_code": "403",
                "ced_name": "Boothby",
                "eo_national_decile": "7",
                "eo_national_percentile": "63",
                "eo_national_rank": "34705",
                "eo_score": "1035",
                "eo_state_decile": "8",
                "eo_state_percentile": "72",
                "eo_state_rank": "2911",
                "er_national_decile": "5",
                "er_national_percentile": "44",
                "er_national_rank": "23835",
                "er_score": "992",
                "er_state_decile": "6",
                "er_state_percentile": "55",
                "er_state_rank": "2208",
                "gcc_sa_code": "4GADE",
                "gcc_sa_name": "Greater Adelaide",
                "is_principal": "P",
                "lga_code": "42600",
                "lga_name": "Holdfast Bay (C)",
                "ra_code": "40",
                "ra_name": "Major Cities of Australia",
                "rsead_national_decile": "6",
                "rsead_national_percentile": "51",
                "rsead_national_rank": "27535",
                "rsead_score": "1020",
                "rsead_state_decile": "6",
                "rsead_state_percentile": "60",
                "rsead_state_rank": "2431",
                "rsed_national_decile": "6",
                "rsed_national_percentile": "58",
                "rsed_national_rank": "31863",
                "rsed_score": "1027",
                "rsed_state_decile": "8",
                "rsed_state_percentile": "71",
                "rsed_state_rank": "2885",
                "sa1_code_7d": "4105621",
                "sa1_code_main": "40301105621",
                "sa1_population": "313",
                "sa2_code_5d": "41056",
                "sa2_code_main": "403011056",
                "sa2_name": "Brighton (SA)",
                "sa3_code": "40301",
                "sa3_name": "Holdfast Bay",
                "sa4_code": "403",
                "sa4_name": "Adelaide - South",
                "sed_code": "40018",
                "sed_name": "Gibson",
                "state_code": "4",
                "state_name": "South Australia"
            },
            "meshblockId": "40059080000"
        }
    ]
}

Using Linktable and Parcel Locker Plus

Please note that moreSources option cannot be used for sourcing data from Linktable as an additional source. End user wanting to source data from AUPOST and linktable can define locale and baseSource for linktable access and additional source as AUPOST. Refer Request 8.

Request 8: Request to demonstrate source as Linktable index and additional source as AUPOST.

{
  "option": 

{   "locale":"AU",   "baseSource":"AUPAF",   "moreSources":["AUPOST"], "top":5     }
,
  "payload": 

{     "fullAddress": "AUSTRALIA POST PARCEL LOCKER 122P STUDIO LANE, DOCKLANDS VIC 3008"   }
}

Response 8: Response shows records from both Linktable (base as AUPAF) and additional source AUPOST.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "fullAddress": "Harbour Town Parcel Locker, 122p Studio Lane, DOCKLANDS VIC 3008",
            "addressLine1": "122p Studio Lane",
            "addressLine2": "DOCKLANDS VIC 3008",
            "dpid": "52753347",
            "localityName": "DOCKLANDS",
            "postcode": "3008",
            "buildingName1": "Harbour Town Parcel Locker",
            "latitude": "-37.813623",
            "longitude": "144.937280",
            "id": "52753347_UPL",
            "attributes": {
                "address_line_1": "122p Studio Lane",
                "description": "Available 24/7",
                "id": "52753347_UPL",
                "location_description": "Parcel Locker is located in the Harbour Town Mail room",
                "name": "Harbour Town Parcel Locker",
                "record_type": "upl",
                "type": "UPL"
            }
        },
        {
            "fullAddress": "AUSTRALIA POST PARCEL LOCKER, 122P STUDIO LANE, DOCKLANDS VIC 3008",
            "addressLine1": "122P STUDIO LANE",
            "addressLine2": "DOCKLANDS VIC 3008",
            "dpid": "52753347",
            "pafPosition": "SINGLE",
            "localityName": "DOCKLANDS",
            "postcode": "3008",
            "state": "VIC",
            "streetName": "STUDIO",
            "streetType": "LANE",
            "houseNumber1": "122",
            "houseNumberSuffix1": "P",
            "buildingName1": "AUSTRALIA POST PARCEL LOCKER",
            "gnafLocalityPID": "locddc4a1bcd8ba",
            "gnafGroupPID": "VIC3336264",
            "gnafPointPID": "GAVIC719242279",
            "gnafPID": "GAVIC719242279",
            "gnafPosition": "SINGLE",
            "gnafGeocodeLevel": "7",
            "gnafReliability": "2",
            "gnafGeocodeConfidence": "0",
            "latitude": "-37.81283968",
            "longitude": "144.93820428",
            "attributes": {
                "MeshBlockID2016": "20631995410",
                "MeshBlockID2021": "20631995410",
                "advertising_mail_ind": "N",
                "area_sqkm": "0.4651",
                "ced_code": "231",
                "ced_name": "Melbourne",
                "deliver_mail_ind": "N",
                "eo_national_decile": "9",
                "eo_national_percentile": "90",
                "eo_national_rank": "49228",
                "eo_score": "1132",
                "eo_state_decile": "9",
                "eo_state_percentile": "88",
                "eo_state_rank": "11943",
                "er_national_decile": "1",
                "er_national_percentile": "5",
                "er_national_rank": "2396",
                "er_score": "822",
                "er_state_decile": "1",
                "er_state_percentile": "4",
                "er_state_rank": "433",
                "gcc_sa_code": "2GMEL",
                "gcc_sa_name": "Greater Melbourne",
                "geo_centroid_confidence": "1",
                "geo_centroid_feature_code": "centroid",
                "geo_centroid_feature_label": "Centroid",
                "geo_centroid_latitude": "-37.812841",
                "geo_centroid_longitude": "144.938204",
                "is_principal": "P",
                "lga_code": "24600",
                "lga_name": "Melbourne (C)",
                "non_delivery_reason": "NYB",
                "non_residential_ind": "N",
                "ra_code": "20",
                "ra_name": "Major Cities of Australia",
                "residential_ind": "Y",
                "rsead_national_decile": "4",
                "rsead_national_percentile": "37",
                "rsead_national_rank": "20237",
                "rsead_score": "988",
                "rsead_state_decile": "4",
                "rsead_state_percentile": "33",
                "rsead_state_rank": "4440",
                "rsed_national_decile": "7",
                "rsed_national_percentile": "67",
                "rsed_national_rank": "36774",
                "rsed_score": "1050",
                "rsed_state_decile": "7",
                "rsed_state_percentile": "65",
                "rsed_state_rank": "8822",
                "sa1_code_7d": "2111809",
                "sa1_code_main": "20604111809",
                "sa1_population": "469",
                "sa2_code_5d": "21118",
                "sa2_code_main": "206041118",
                "sa2_name": "Docklands",
                "sa3_code": "20604",
                "sa3_name": "Melbourne City",
                "sa4_code": "206",
                "sa4_name": "Melbourne - Inner",
                "sed_code": "24703",
                "sed_name": "Melbourne (Northern Metropolitan)",
                "state_code": "2",
                "state_name": "Victoria"
            },
            "meshblockId": "20631995410"
        }
    ]
}