HapiCoordLocation

data class HapiCoordLocation(id: String?, extId: String?, name: String, type: HapiLocationType, lon: Double?, lat: Double?, dist: Int?, refinable: Boolean, matchValue: Int?, LocationNotes: List<HapiLocationNote>, links: List<HapiResourceLink>, icon: HapiIcon?) : HapiStopOrCoordLocation

The element CoordLocation specifies a coordinate based location in a result of a location request. It contains an output name, latitude, longitude and a type (address or point of interest). The coordinates and the name can be used as origin or destination parameters to perform a trip request.

Constructors

HapiCoordLocation

fun HapiCoordLocation(id: String?, extId: String?, name: String, type: HapiLocationType, lon: Double?, lat: Double?, dist: Int?, refinable: Boolean = false, matchValue: Int?, LocationNotes: List<HapiLocationNote> = emptyList(), links: List<HapiResourceLink> = emptyList(), icon: HapiIcon?)

Properties

dist

val dist: Int?

This value specifies the distance to the given coordinate if called by a nearby search request.

extId

val extId: String?

This ID defines an alternative ID for this stop location and can not be used to perform further requests.

icon

val icon: HapiIcon?

val id: String?

This optional ID can either be used as originId or destId to perform a trip request.

lat

val lat: Double?

The WGS84 latitude of the geographical position of the stop/station.

links

val links: List<HapiResourceLink>

LocationNotes

val LocationNotes: List<HapiLocationNote>

lon

val lon: Double?

The WGS84 longitude of the geographical position of the stop/station.

matchValue

val matchValue: Int?

A percentage value 0, 100 indicating how well the name of the given location matches the input location name. This attribute is only available in the location.name response

name

val name: String

Contains the output name of the address or point of interest

refinable

val refinable: Boolean = false

True, if the stop is not resolved fully and could be refined.

type

val type: HapiLocationType

The attribute type specifies the type of location. Valid values are ADR (address), POI (point of interest), CRD (coordinate), MCP (mode change point) or HL (hailing point).