HapiStopLocation

data class HapiStopLocation(id: String, extId: String, hasMainMast: Boolean?, mainMastId: String?, mainMastExtId: String?, name: String, lon: Double?, lat: Double?, track: String?, weight: Int?, dist: Int?, products: Int?, meta: Boolean, refinable: Boolean, matchValue: Int?, entry: Boolean?, LocationNotes: List<HapiLocationNote>, Message: List<HapiMessage>, productAtStop: List<HapiProduct>, TariffResult: HapiTariffResult?, links: List<HapiResourceLink>, altId: List<String>, mainMastAltId: List<String>, timezoneOffset: ZoneOffset?) : HapiStopOrCoordLocation

The element StopLocation specifies a stop/station in a result of a location request.

Constructors

HapiStopLocation

fun HapiStopLocation(id: String, extId: String, hasMainMast: Boolean?, mainMastId: String?, mainMastExtId: String?, name: String, lon: Double?, lat: Double?, track: String?, weight: Int?, dist: Int?, products: Int?, meta: Boolean = false, refinable: Boolean = false, matchValue: Int?, entry: Boolean?, LocationNotes: List<HapiLocationNote> = emptyList(), Message: List<HapiMessage> = emptyList(), productAtStop: List<HapiProduct> = emptyList(), TariffResult: HapiTariffResult?, links: List<HapiResourceLink> = emptyList(), altId: List<String> = emptyList(), mainMastAltId: List<String> = emptyList(), timezoneOffset: ZoneOffset?)

Properties

altId

val altId: List<String>

dist

val dist: Int?

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

entry

val entry: Boolean?

True, if the stop is an entry point.

extId

val extId: String

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

hasMainMast

val hasMainMast: Boolean?

True if this stop belongs to a main mast.

val id: String

This ID can either be used as originId or destId to perform a trip request or to call a departure or arrival board.

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>

Contains a list of notes to be displayed for this location, like attributes or footnotes.

lon

val lon: Double?

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

mainMastAltId

val mainMastAltId: List<String>

mainMastExtId

val mainMastExtId: String?

External ID of the main mast this stop belongs to.

mainMastId

val mainMastId: String?

ID of the main mast this stop belongs to.

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

Message

val Message: List<HapiMessage>