search:search-client-api/com.tomtom.sdk.search.client.model.location/Address

Address

data class Address( val streetNumber: String = "", val streetName: String = "", val municipalitySubdivision: String = "", val municipality: String = "", val countrySecondarySubdivision: String = "", val countryTertiarySubdivision: String = "", val countrySubdivision: String = "", val postalCode: String = "", val extendedPostalCode: String = "", val countryCode: String = "", val country: String = "", val countryCodeISO3: String = "", val freeformAddress: String = "", val countrySubdivisionName: String = "", val localName: String = "")

Describes the detailed address.

Parameters

streetNumber

The building's number.

streetName

The street name.

municipalitySubdivision

The sub/super city.

municipality

The city/town.

countrySecondarySubdivision

The county.

countryTertiarySubdivision

The named area.

countrySubdivision

The state or province.

postalCode

The postal code.

extendedPostalCode

The extended postal code (availability dependent on region).

countryCode

The country code.

country

The name of the country.

countryCodeISO3

The ISO3-standard country code. See https://www.iso.org/obp/ui/#search for more details.

freeformAddress

The freeform address - the full address in a usable form.

countrySubdivisionName

The full name of the first level of a country administrative hierarchy. This field only appears in case countrySubdivision is presented in an abbreviated form. Supported only for USA, Canada, and Great Britain.

localName

An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

Address

fun Address( streetNumber: String = "", streetName: String = "", municipalitySubdivision: String = "", municipality: String = "", countrySecondarySubdivision: String = "", countryTertiarySubdivision: String = "", countrySubdivision: String = "", postalCode: String = "", extendedPostalCode: String = "", countryCode: String = "", country: String = "", countryCodeISO3: String = "", freeformAddress: String = "", countrySubdivisionName: String = "", localName: String = "")