# Address Type Objects

## Address Type Objects

| [Metadata](#universal)                      | Wrapper for name/value pairs.           |
| ------------------------------------------- | --------------------------------------- |
| [MetadatList](#addressau)                   | Container for Metadata objects.         |
| [MetadataRestRequest](#addressnz)           | Request wrapper for type REST methods.  |
| [MetadataRestResponse](#validatedaddressau) | Response wrapper for type REST methods. |

### Metadata <a href="#universal" id="universal"></a>

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

```json

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

### MetadataList <a href="#addressau" id="addressau"></a>

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

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

### MetadataRestRequest <a href="#addressnz" id="addressnz"></a>

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

```json
   
    {
        "sourceOfTruth": "AUPAF"
    }
```

### MetadataRestResponse <a href="#validatedaddressau" id="validatedaddressau"></a>

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

#### payload

Type: [`MetadatList`](#addressau)

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mastersoftgroup.com/loqate-harmony-api/api-specification/objects/address-objects-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.