Skip to main content

Addressable

This interface is included in the Core module.

Description​

Implemented by all designs (such as assets) that have an address.

Properties​

This interface has the following properties.

PropertyValue
NameAddressable
CodedesignInterfaces_addressable
TypeInterface
ContextCore
AI agent enabledtrue
AI agent descriptionShared interface implemented by all designs (assets, accounts, etc.) that carry a postal address.
Icon-
Colour-
Title-
Subtitle-

Implements​

This interface doesn't implement any other interfaces.

Attributes​

This interface has the following attributes.

Address Line 1​

The first line of the postal address (typically the building number and street name).

PropertyValue
NameAddress Line 1
Codeattributes_addressableAddressLine1
TypeString
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Options
{
"max": 128
}

Address Line 2​

The second line of the postal address (e.g. district, village, or additional address detail).

PropertyValue
NameAddress Line 2
Codeattributes_addressableAddressLine2
TypeString
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Options
{
"max": 128
}

Region​

The region, county, or administrative area of the postal address.

PropertyValue
NameRegion
Codeattributes_addressableRegion
TypeString
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Options
{
"max": 32
}

Postcode​

The UK postcode for this address, used for location lookup and routing.

PropertyValue
NamePostcode
Codeattributes_addressablePostcode
TypeString
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Options
{
"max": 12
}

Country​

The country component of the postal address.

PropertyValue
NameCountry
Codeattributes_addressableCountry
TypeString
Requiredfalse
Uniquefalse
Read-onlyfalse
AI agent enabledtrue
Options
{
"max": 32
}

Standard paths​

This interface doesn't have any standard paths of its own.

Permissions​

This interface has no defined permissions.