Create Address

Creates address in Address Exchange using structured data

Resource

POST    https://hosted.mastersoftgroup.com/harmony/rest/address/exchange/v1/addresses

Request

The request body is similar to AddressRestRequest object.

{
  "buildingName": "string",
  "country": "AU",
  "flatUnitNumber": "string",
  "flatUnitType": "string",
  "floorLevelNumber": "string",
  "floorLevelType": "string",
  "latitude": "string",
  "line1": "string",
  "line2": "string",
  "longitude": "string",
  "postcode": "string",
  "state": "string",
  "streetName": "string",
  "streetNumber": "string",
  "streetType": "string",
  "suburb": "string",
}

Response

The response plays back the submitted Address with status.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": {
        "uuid": "788c4c23-fb69-4296-87aa-0650d514283f",
        "createDate": 1691992029508,
        "updateDate": 1691992029508,
        "assessments": [
            {
                "uuid": "13bf0035-f939-4f08-8a62-a9e9860e0872",
                "assessmentDate": 1691992029673,
                "events": null,
                "score": null
            }
        ],
        "attributes": null,
        "country": "AU",
        "postcode": "3144",
        "suburb": "MALVERN",
        "state": "VIC",
        "line1": null,
        "line2": null,
        "streetNumber1Prefix": null,
        "streetNumber1": "23",
        "streetNumber1Suffix": "",
        "streetNumber2Prefix": null,
        "streetNumber2": "25",
        "streetNumber2Suffix": "",
        "postalType": null,
        "postalNumber": null,
        "buildingName": "",
        "subdwelling": null,
        "lotNumber": "",
        "flatUnitNumber": "",
        "flatUnitType": "",
        "floorLevelNumber": "",
        "floorLevelType": "",
        "streetSuffix": "",
        "streetType": "PDE",
        "streetName": "MILTON",
        "rdNumber": "",
        "district": null,
        "latitude": "-37.84615841",
        "longitude": "145.03898928",
        "description": null,
        "fullAddress": "23-25 MILTON PDE, MALVERN VIC 3144"
    }
}