Interface AddressModel

Identifies a geographic address

interface AddressModel {
    DE_S0326?: string;
    DE_S0347?: string;
    additionalIdentifier?: string;
    alpha2Code?: string;
    bbox?: Bbox;
    complementOfInformation?: string;
    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? DE_S0347? additionalIdentifier? alpha2Code? bbox? complementOfInformation? confidence? country? display? district? errors? formattedAddress? input? isEU? lastChangedBy? latitude? locality? longitude? modifiedAt? modifiedBy? options? plusCode? postalCode? province? provinceCode? reason? required? reviewNeeded? searchValue? source? streetName? streetNumber? sublocality? templateValue? treatyMemberships? userEdited? value?

Properties

Optional DE_S0326

DE_S0326?: string

QualifierOfIdentification

Optional DE_S0347

DE_S0347?: string

TypeOfLocation

Optional additionalIdentifier

additionalIdentifier?: string

Optional alpha2Code

alpha2Code?: string

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional complementOfInformation

complementOfInformation?: string

e.g. company name, mostly needed for place of loading

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional country

country?: string

Optional display

display?: boolean

Optional district

district?: string

Optional errors

errors?: ErrorModel[]

could be validation errors

Optional formattedAddress

formattedAddress?: string

Optional input

input?: string

The input value which was initially supplied for the property

Optional isEU

isEU?: boolean

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

Optional latitude

latitude?: number

Optional locality

locality?: string

Optional longitude

longitude?: number

Optional modifiedAt

modifiedAt?: number

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

Optional modifiedBy

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

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string

Optional options

options?: any[]

Optional plusCode

plusCode?: string

Optional postalCode

postalCode?: string

Optional province

province?: string

Optional provinceCode

provinceCode?: string

Optional reason

reason?: any

Optional required

required?: boolean

Optional reviewNeeded

reviewNeeded?: boolean

Optional searchValue

searchValue?: string

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

Optional source

source?: string

Optional streetName

streetName?: string

Optional streetNumber

streetNumber?: string

Optional sublocality

sublocality?: string

Optional templateValue

templateValue?: string

Template value which was used to generate the value

Optional treatyMemberships

treatyMemberships?: string[]

Optional userEdited

userEdited?: boolean

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

Optional value

value?: string

The current value of the property

Settings

Member Visibility

Theme

On This Page

DE_S0326DE_S0347additionalIdentifieralpha2CodebboxcomplementOfInformationconfidencecountrydisplaydistricterrorsformattedAddressinputisEUlastChangedBylatitudelocalitylongitudemodifiedAtmodifiedByoptionsplusCodepostalCodeprovinceprovinceCodereasonrequiredreviewNeededsearchValuesourcestreetNamestreetNumbersublocalitytemplateValuetreatyMembershipsuserEditedvalue