Comment on page
Address Types

​
These methods have been deprecated. 
We recommend you upgrade your service to the latest Address Validation method. Upgrade at no cost and improved performance.
Address type methods (AU/NZ)
Address type methods provide address type information from a specific Source of Truth.
​floorLevel​
Retrieves the floor level types.
​postal​
Retrieves the postal types.
​street​
Retrieves the street types.
​streetSuffix​
Retrieves the street suffix types.
​unitFlat​
Retrieves the unit/flat types.
floorLevel
Retrieves the list of Floor Level types available in the Source of Truth. No additional input is required.
Resource URL
    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/floorLevel
    
Request (POST)
The request body is a MetadataRestRequest object:
The sourceOfTruth attribute is required
​
    {
        "sourceOfTruth": "AUPAF"
    }
 
Response
The response body is an MetadataRestResponse object:
    
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            { 
                "name": "B",
                "value": "B"
            },
            {
                "name": "BASEMENT",
                "value": "B"
            },
            {
                "name": "FL",
                "value": "FL"
            },
            ...
        ]
    }
postal
Retrieves the list of Postal types available in the Source of Truth. No additional input is required.
Resource URL
    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/postal
Request (POST)
The request body is a MetadataRestRequest object:
The sourceOfTruth attribute is required
    {
        "sourceOfTruth": "AUPAF"
    }
Response
The response body is a MetadataRestResponse object:
​
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "name": "C POST OFFICE",
                "value": "CARE PO"
            },
            {
                "name": "C/ P O BOX",
                "value": "PO BOX"
            },
            {
                "name": "C/ PO BOX",
                "value": "PO BOX"
            },
            ...
        ]
    }
    
street
Retrieves the list of Street types available in the Source of Truth. No additional input is required.
Resource URL
    POST   https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/street
    
Request (POST)
The request body is a MetadataRestRequest object:
The sourceOfTruth attribute is required
​
    {
        "sourceOfTruth": "AUPAF"
    }
Response
The response body is a MetadataRestResponse object:
​
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "name": "ACCESS",
                "value": "ACCS"
            },
            {
                "name": "ACCS",
                "value": "ACCS"
            },
            {
                "name": "ALLEY",
                "value": "ALLY"
            },
            ...
        ]
    }
    
    
streetSuffix
Retrieves the list of Street Suffix types available in the Source of Truth. No additional input is required.
Resource URL
    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/streetSuffix   
Request (POST)
The request body is a MetadataRestRequest object:
The sourceOfTruth attribute is required
​
    {
        "sourceOfTruth": "AUPAF"
    }
Response
The response body is a MetadataRestResponse object:
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "name": "CENTRAL",
                "value": "CN"
            },
            {
                "name": "CN",
                "value": "CN"
            },
            {
                "name": "E",
                "value": "E"
            },
            ...
        ]
    }
    
    
unitFlat
Retrieves the list of Unit/Flat types available in the Source of Truth. No additional input is required.
Resource URL
    POST    https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/unitFlat    
Request (POST)
The request body is a MetadataRestRequest object:
The sourceOfTruth attribute is required
​
    {
        "sourceOfTruth": "AUPAF"
    }
    
Response
The response body is a MetadataRestResponse object:
    
    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "name": "AMENT",
                "value": "APT"
            },
            {
                "name": "AMT",
                "value": "APT"
            },
            {
                "name": "AP",
                "value": "APT"
            },
            ...
        ]
    }
Address Combined
Next - Loqate Harmony API
Guides
Last modified 8mo ago
floorLevel	Retrieves the floor level types.
postal	Retrieves the postal types.
street	Retrieves the street types.
streetSuffix	Retrieves the street suffix types.
unitFlat	Retrieves the unit/flat types.