mdb-v1/dev.sargunv.mobilitydata.mdb.v1/LocationSearchResult

LocationSearchResult

data class LocationSearchResult(val locationId: Int? = null, val parentLocationId: Int? = null, val name: String? = null, val altName: String? = null, val locationType: LocationType? = null, val countryName: String? = null, val countryCode: String? = null, val subdivisionName: String? = null, val subdivisionCode: String? = null, val pathNames: List<String>? = null, val displayName: String? = null)(source)

One location in a search result page.

Constructors

LocationSearchResult

constructor(locationId: Int? = null, parentLocationId: Int? = null, name: String? = null, altName: String? = null, locationType: LocationType? = null, countryName: String? = null, countryCode: String? = null, subdivisionName: String? = null, subdivisionCode: String? = null, pathNames: List<String>? = null, displayName: String? = null)

Properties

@SerialName(value = "alt_name")

val altName: String?

Alternate or local name.

@SerialName(value = "country_code")

val countryCode: String?

ISO 3166-1 alpha-2 code of the containing country.

@SerialName(value = "country_name")

val countryName: String?

Name of the containing country.

@SerialName(value = "display_name")

val displayName: String?

Human-readable hierarchy joined from the broadest area to this location.

@SerialName(value = "location_id")

val locationId: Int?

Stable location identifier.

@SerialName(value = "location_type")

val locationType: LocationType?

Whether this row is a country, subdivision, or municipality.

val name: String?

Primary name, in English when available.

parentLocationId

@SerialName(value = "parent_location_id")

val parentLocationId: Int?

Identifier of the nearest containing location.

@SerialName(value = "path_names")

val pathNames: List<String>?

Names from the broadest containing area down to this location.

subdivisionCode

@SerialName(value = "subdivision_code")

val subdivisionCode: String?

ISO 3166-2 code of the containing subdivision.

subdivisionName

@SerialName(value = "subdivision_name")

val subdivisionName: String?

Name of the containing subdivision.