Premises

This interface is included in the Premises module.

Description

Implemented by all premises.

Properties

This interface has the following properties.

Property	Value
Name	Premises
Code	designInterfaces_premises
Type	Interface
Context	Module
AI agent enabled	true
AI agent description	Shared interface for property and building asset designs.
Icon	icon-resource-house
Colour	#4aa36b
Title	-
Subtitle	-

Implements

This interface implements the following interfaces.

Name	Code
Asset Heads	designInterfaces_assetHeads
Notifications Assignable	designInterfaces_notificationsAssignable

Attributes

This interface has the following attributes. It may also inherit attributes from any of the interfaces it implements.

Primary Start Number

The start number of the primary address range for this premises.

Property	Value
Name	Primary Start Number
Code	attributes_premisesPrimaryStartNumber
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "min": 1 }

Primary Start Suffix

The suffix appended to the primary start number of this premises address.

Property	Value
Name	Primary Start Suffix
Code	attributes_premisesPrimaryStartSuffix
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 2 }

Primary End Number

The end number of the primary address range for this premises.

Property	Value
Name	Primary End Number
Code	attributes_premisesPrimaryEndNumber
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "min": 1 }

Primary End Suffix

The suffix appended to the primary end number of this premises address.

Property	Value
Name	Primary End Suffix
Code	attributes_premisesPrimaryEndSuffix
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 2 }

Primary Text

The primary address text component for this premises.

Property	Value
Name	Primary Text
Code	attributes_premisesPrimaryText
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 90 }

Secondary Start Number

The start number of the secondary address component for this premises.

Property	Value
Name	Secondary Start Number
Code	attributes_premisesSecondaryStartNumber
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "min": 1 }

Secondary Start Suffix

The suffix for the secondary address component start number.

Property	Value
Name	Secondary Start Suffix
Code	attributes_premisesSecondaryStartSuffix
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 2 }

Secondary End Number

The end number of the secondary address component (e.g., flat number range) for this premises.

Property	Value
Name	Secondary End Number
Code	attributes_premisesSecondaryEndNumber
Type	Number
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "min": 1 }

Secondary End Suffix

The suffix for the secondary address component end number.

Property	Value
Name	Secondary End Suffix
Code	attributes_premisesSecondaryEndSuffix
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 2 }

Secondary Text

The secondary address text component (e.g., building or flat descriptor) for this premises.

Property	Value
Name	Secondary Text
Code	attributes_premisesSecondaryText
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 90 }

Level

The floor or level designation for this premises in a multi-storey building.

Property	Value
Name	Level
Code	attributes_premisesLevel
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 128 }

Postcode

The UK postcode for this premises.

Property	Value
Name	Postcode
Code	attributes_premisesPostcode
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 10 }

Postal Town

The postal town for this premises.

Property	Value
Name	Postal Town
Code	attributes_premisesPostalTown
Type	String
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Options	{ "max": 128 }

Sub Premises

Links to the sub-premises descriptor (e.g., apartment or suite identifier) for this premises.

Property	Value
Name	Sub Premises
Code	attributes_premisesSubPremises
Type	Link
Required	false
Unique	false
Read-only	false
AI agent enabled	true
Links to	Premises
Options	{ "code": "designInterfaces_premises", "graph": "Premises", "weakReference": true }

Standard paths

This interface doesn't have any standard paths of its own. However, it may inherit standard paths from any of the interfaces it implements.

Permissions

This interface defines the following permissions.

User group	Allowed
Premises Viewers	Read
Premises Managers	Read, Create, Edit, Delete

Default attribute permissions

This interface applies the following default permissions to all attributes for the following user groups.

Allowed	User group	Code
ReadOnly	Premises Viewers	userGroups_premisesViewers
ReadWrite	Premises Managers	userGroups_premisesManagers