Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | FiasAddressObject/(resolvedAttributes)/RecId | attribute |
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.1" | string | semantic version number of the entity |
is.application.releaseVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| releaseVersion | "10.0.13.0" | string | semantic version number of the application introducing this entity |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
Attributes
RecId
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| isPrimaryKey | true |
| dataFormat | int64 |
| isReadOnly | true |
Traits
List of traits for the RecId attribute are listed below.
is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | FiasAddressObject/(resolvedAttributes)/RecId | attribute |
is.readOnly
is.dataFormat.integer
is.dataFormat.big
AOId
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the AOId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
AOGuid
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the AOGuid attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
AOLevel
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the AOLevel attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
RegionCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the RegionCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
AreaCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the AreaCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
CityCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the CityCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
CtArCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the CtArCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
PlaceCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the PlaceCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
PlanCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the PlanCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
StreetCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the StreetCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
ExtrCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ExtrCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
ActStatus
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ActStatus attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
LiveStatus
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the LiveStatus attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
OperStatus
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the OperStatus attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
OffName
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the OffName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
ParentGuid
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ParentGuid attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
ShortName
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the ShortName attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
PostalCode
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the PostalCode attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
IFNSFL
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the IFNSFL attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
TerrIFNSFL
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the TerrIFNSFL attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
OKATO
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the OKATO attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
DivType
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the DivType attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
NextId
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the NextId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
PrevId
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isNullable | true |
Traits
List of traits for the PrevId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.
is.dataFormat.character
is.dataFormat.array
DataAreaId
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | string |
| isReadOnly | true |
Traits
List of traits for the DataAreaId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array
Relationship_CompanyRelationshipId
First included in: Miscellaneous/FiasAddressObject (this entity)
Properties
| Name | Value |
|---|---|
| dataFormat | guid |
Traits
List of traits for the Relationship_CompanyRelationshipId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array