General.Geography.AdministrativeRegions Entity

Namespace: General.Geography

Hierarchical structure of the legally defined administrative regions. Administrative regions are sub-divisions of the countries. Entity: Gen_Administrative_Regions

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

General.Geography.AdministrativeRegions

Attributes

Name	Type	Description
Code	string (16)	Administrative code of country territorial subdivision. `Required` `Filter(eq;like)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FullPath	string (254) nullable	Full identification path of the current country territorial subdivision. `Filter(eq;like)`
Id	guid
Name	MultilanguageString (254)	Name of country territorial subdivision. `Required` `Filter(like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ParentFullPath	string (254) nullable	Parent region of the current territorial subdivision. `Filter(eq;like)`
ValidFrom	date nullable	Start date of validity of this administrative division. null when the starting date is unknown in the past. `Filter(ge;le)`
ValidTo	date nullable	End date of validity of this administative division. null when the division is still active or ending date is unknown. `Filter(ge;le)`

References

Name	Type	Description
Country	Countries	Country of the territorial subdivision. `Required` `Filter(multi eq)`

Attribute Details

Code

Administrative code of country territorial subdivision. Required Filter(eq;like)

Type: string (16)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

FullPath

Full identification path of the current country territorial subdivision. Filter(eq;like)

Type: string (254) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Name

Name of country territorial subdivision. Required Filter(like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ParentFullPath

Parent region of the current territorial subdivision. Filter(eq;like)

Type: string (254) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

ValidFrom

Start date of validity of this administrative division. null when the starting date is unknown in the past. Filter(ge;le)

Type: date nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ValidTo

End date of validity of this administative division. null when the division is still active or ending date is unknown. Filter(ge;le)

Type: date nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

Country

Country of the territorial subdivision. Required Filter(multi eq)

Type: Countries
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST