gbfs-v3/dev.sargunv.mobilitydata.gbfs.v3/Station

Station

data class Station(val stationId: String, val name: LocalizedText, val shortName: LocalizedText? = null, val lat: Double, val lon: Double, val address: String? = null, val crossStreet: String? = null, val regionId: String? = null, val postalCode: String? = null, val stationOpeningHours: OsmOpeningHours? = null, val rentalMethods: List<RentalMethod>? = null, val isVirtualStation: Boolean? = null, val stationArea: MultiPolygon? = null, val parkingType: ParkingType? = null, val parkingHoop: Boolean? = null, val contactPhone: String? = null, val capacity: Int? = null, val vehicleDocksCapacity: List<CountByMultipleVehicleTypes>? = null, val vehicleTypeCapacity: List<CountByMultipleVehicleTypes>? = null, val isValetStation: Boolean? = null, val isChargingStation: Boolean? = null, val rentalUris: RentalUris? = null)(source)

Information about a single station.

Constructors

Station

constructor(stationId: String, name: LocalizedText, shortName: LocalizedText? = null, lat: Double, lon: Double, address: String? = null, crossStreet: String? = null, regionId: String? = null, postalCode: String? = null, stationOpeningHours: OsmOpeningHours? = null, rentalMethods: List<RentalMethod>? = null, isVirtualStation: Boolean? = null, stationArea: MultiPolygon? = null, parkingType: ParkingType? = null, parkingHoop: Boolean? = null, contactPhone: String? = null, capacity: Int? = null, vehicleDocksCapacity: List<CountByMultipleVehicleTypes>? = null, vehicleTypeCapacity: List<CountByMultipleVehicleTypes>? = null, isValetStation: Boolean? = null, isChargingStation: Boolean? = null, rentalUris: RentalUris? = null)

Properties

address

val address: String?

Address (street number and name) where station is located.

capacity

val capacity: Int?

Number of total docking points installed at this station, both available and unavailable, regardless of what vehicle types are allowed at each dock.

contactPhone

@SerialName(value = "contact_phone")

val contactPhone: String?

Contact phone of the station, in the E.164 format.

crossStreet

@SerialName(value = "cross_street")

val crossStreet: String?

Cross street or landmark where the station is located.

isChargingStation

@SerialName(value = "is_charging_station")

val isChargingStation: Boolean?

Does the station support charging of electric vehicles?

isValetStation

@SerialName(value = "is_valet_station")

val isValetStation: Boolean?

Are valet services provided at this station?

isVirtualStation

@SerialName(value = "is_virtual_station")

val isVirtualStation: Boolean?

Is this station a location with or without smart dock technology?

lat

val lat: Double

Latitude of the station in decimal degrees.

lon

val lon: Double

Longitude of the station in decimal degrees.

name

val name: LocalizedText

The public name of the station for display in maps, digital signage, and other text applications.

parkingHoop

@SerialName(value = "parking_hoop")

val parkingHoop: Boolean?

Are parking hoops present at this station?

parkingType

@SerialName(value = "parking_type")

val parkingType: ParkingType?

Type of parking station.

postalCode

@SerialName(value = "post_code")

val postalCode: String?

Postal code where the station is located.

regionId

@SerialName(value = "region_id")

val regionId: String?

Identifier of the region where station is located. See system_regions.json.

rentalMethods

@SerialName(value = "rental_methods")

val rentalMethods: List<RentalMethod>?

Payment methods accepted at this station.

rentalUris

@SerialName(value = "rental_uris")

val rentalUris: RentalUris?

Contains rental URIs for Android, iOS, and web.

shortName

@SerialName(value = "short_name")

val shortName: LocalizedText?

Short name or other type of identifier.

stationArea

@SerialName(value = "station_area")

val stationArea: MultiPolygon?

A GeoJSON MultiPolygon that describes the area of a virtual station.

stationId

@SerialName(value = "station_id")

val stationId: String

Identifier of a station.

stationOpeningHours

@SerialName(value = "station_opening_hours")

val stationOpeningHours: OsmOpeningHours?

Hours of operation for the station in OSM opening_hours format.

vehicleDocksCapacity

@SerialName(value = "vehicle_docks_capacity")

val vehicleDocksCapacity: List<CountByMultipleVehicleTypes>?

These objects are used to model the total docking capacity of a station, both available and unavailable, for each type of vehicle that may dock at this station. The total number of docks from each of these objects SHOULD add up to match the value specified in the capacity field.

vehicleTypeCapacity

@SerialName(value = "vehicle_types_capacity")

val vehicleTypeCapacity: List<CountByMultipleVehicleTypes>?

These objects are used to model the parking capacity of virtual stations (defined using the is_virtual_station field) for each vehicle type that can be returned to this station. The total number of vehicles from each of these objects SHOULD add up to match the value specified in the capacity field.