sdk-search / com.tomtom.online.sdk.search.fuzzy / FuzzySearchDetails

FuzzySearchDetails

@PublicPreview("2021.06") data class FuzzySearchDetails : Serializable

Describes the details of the FuzzyOutcome returned by the Search API.

Parameters

type - The type of result.

id - The ID of the result.

score - The score of the result.

address - The detailed address of the result.

position - The geographical position of the POI.

viewport - The viewport.

distance - The distance from the route provided.

info - Additional information.

entityType - (Only for results of type "Geography") The type of the entity (one of "County", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTeritarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighbourhood", "PostalCodeArea").

poi - Information about the POI.

boundingBox - A rectangle into which the shape of an administrative area is inscribed. Only available for results where the result type is equal to "Geography", and municipality information is not present.

entryPoints - A list of entrances to the POI.

addressRanges - Address ranges on a street segment. Only available for results where the result type is equal to "Address Range".

additionalDataSources - Information about the sources of additional data that can be used with the Additional Data service.

mapCodes - A list of MapCode objects.

Properties

additionalDataSources

val additionalDataSources: AdditionalDataSources?

Information about the sources of additional data that can be used with the Additional Data service.

address

val address: Address?

The detailed address of the result.

addressRanges

val addressRanges: AddressRanges?

Address ranges on a street segment. Only available for results where the result type is equal to "Address Range".

boundingBox

val boundingBox: BoundingBox?

A rectangle into which the shape of an administrative area is inscribed. Only available for results where the result type is equal to "Geography", and municipality information is not present.

distance

val distance: Double

The distance from the route provided.

entityType

val entityType: String

(Only for results of type "Geography") The type of the entity (one of "County", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTeritarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighbourhood", "PostalCodeArea").

entryPoints

val entryPoints: List<EntryPoint>

A list of entrances to the POI.

id

val id: String

The ID of the result.

info

val info: String

Additional information.

mapCodes

val mapCodes: List<MapCode>

A list of MapCode objects.

poi

val poi: Poi?

Information about the POI.

position

val position: LatLng

The geographical position of the POI.

score

val score: Double

The score of the result.

type

val type: String

The type of result.

viewport

val viewport: BoundingBox?

The viewport.