Address type methods provide address type information from a specific Source of Truth.
The API Specification, also available on each method below - it requires valid username and password.
| 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. |
Retrieves the list of Floor Level types available in the Source of Truth. No additional input is required.
POST https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/floorLevel
The request body is a MetadataRestRequest object:
{
"sourceOfTruth": "AUPAF"
}
The response body is a MetadataRestResponse object:
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"name": "B",
"value": "B"
},
{
"name": "BASEMENT",
"value": "B"
},
{
"name": "FL",
"value": "FL"
},
...
]
}
Retrieves the list of Postal types available in the Source of Truth. No additional input is required.
POST https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/postal
The request body is a MetadataRestRequest object:
{
"sourceOfTruth": "AUPAF"
}
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"
},
...
]
}
Retrieves the list of Street types available in the Source of Truth. No additional input is required.
POST https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/street
The request body is a MetadataRestRequest object:
{
"sourceOfTruth": "AUPAF"
}
The response body is a MetadataRestResponse object:
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"name": "ACCESS",
"value": "ACCS"
},
{
"name": "ACCS",
"value": "ACCS"
},
{
"name": "ALLEY",
"value": "ALLY"
},
...
]
}
Retrieves the list of Street Suffix types available in the Source of Truth. No additional input is required.
POST https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/streetSuffix
The request body is a MetadataRestRequest object:
{
"sourceOfTruth": "AUPAF"
}
The response body is a MetadataRestResponse object:
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"name": "CENTRAL",
"value": "CN"
},
{
"name": "CN",
"value": "CN"
},
{
"name": "E",
"value": "E"
},
...
]
}
Retrieves the list of Unit/Flat types available in the Source of Truth. No additional input is required.
POST https://hosted.mastersoftgroup.com/harmony/rest/{locale}/type/unitFlat
The request body is a MetadataRestRequest object:
{
"sourceOfTruth": "AUPAF"
}
The response body is a MetadataRestResponse object:
{
"status": "SUCCESS",
"messages": [],
"payload": [
{
"name": "AMENT",
"value": "APT"
},
{
"name": "AMT",
"value": "APT"
},
{
"name": "AP",
"value": "APT"
},
...
]
}