API

Methods

Objects

Address Type Objects

Metadata Wrapper for name/value pairs.
MetadataList Container for Metadata objects.
MetadataRestRequest Request wrapper for type REST methods.
MetadataRestResponse Response wrapper for type REST methods.

Metadata

The Metadata object is used when receiving data from the Harmony RightAddress metadata API methods.

name

Type: String The displayable name of the metadata item (e.g. 'LOWER GROUND').

value

Type: String The value of the metadata item (e.g. 'LG').

JSON Representation


    {
        "name": "CUL-DE-SAC",
        "value": "CDS"
    }

MetadataList

A MetadataList object is an array or list of Metadata structures. It is used to transport multiple instances of Metadata objects (e.g. to return a list of Floor Level or Flat/Unit types).

JSON Representation


    [
        {
            "name": "ACCESS",
            "value": "ACCS"
        },
        {
            "name": "ACCS",
            "value": "ACCS"
        },
        {
            "name": "ALLEY",
            "value": "ALLY"
        },
        ...
    ]

MetadataRestRequest

A MetadataRestRequest object is used when invoking the Harmony RightAddress metadata REST service methods.

sourceOfTruth

Type: String The Source of Truth to use during the REST service method invocation (i.e. 'AUPAF', 'GNAF', 'NZPAF' or 'NZAD'").

JSON Representation


    {
        "sourceOfTruth": "AUPAF"
    }

MetadataRestResponse

A MetadataRestResponse object is returned from the Harmony RightAddress metadata REST service method invocations.

payload

Type: MetadataList The list of Metadata structures being returned from the REST service method invocation.

status

Type: String The status of the request (i.e. 'SUCCESS' or 'ERROR').

messages

Type: String[] Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]').

JSON Representation


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [ { "name": "ACCESS", "value": "ACCS" }, ... ]
    }