Interface AddressModel

Identifies a geographic address

interface AddressModel {
    DE_S0326?: string;
    DE_S0347?: string;
    additionalIdentifier?: string;
    alpha2Code?: string;
    bbox?: Bbox;
    confidence?: number;
    country?: string;
    display?: boolean;
    district?: string;
    errors?: ErrorModel[];
    formattedAddress?: string;
    input?: string;
    isEU?: boolean;
    lastChangedBy?: string;
    latitude?: number;
    locality?: string;
    longitude?: number;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: any[];
    plusCode?: string;
    postalCode?: string;
    province?: string;
    provinceCode?: string;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    streetName?: string;
    streetNumber?: string;
    sublocality?: string;
    templateValue?: string;
    treatyMemberships?: string[];
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

  • Meta<any>
    • AddressModel

Properties

DE_S0326?: string

QualifierOfIdentification

DE_S0347?: string

TypeOfLocation

additionalIdentifier?: string
alpha2Code?: string
bbox?: Bbox

Bounding box of extracted value

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

country?: string
display?: boolean
district?: string
errors?: ErrorModel[]

could be validation errors

formattedAddress?: string
input?: string

The input value which was initially supplied for the property

isEU?: boolean
lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

latitude?: number
locality?: string
longitude?: number
modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

modifiedBy?: {
    displayName?: string;
    id?: string;
}

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string
options?: any[]
plusCode?: string
postalCode?: string
province?: string
provinceCode?: string
reason?: any
required?: boolean
reviewNeeded?: boolean
searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

source?: string
streetName?: string
streetNumber?: string
sublocality?: string
templateValue?: string

Template value which was used to generate the value

treatyMemberships?: string[]
userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

value?: string

The current value of the property