navigation-ux-ev-platform/com.mapbox.ev.platform.model/Location

Location

@Serializable

data class Location(val countryCode: String, val partyId: String, val id: String, val publish: Boolean, val address: String, val city: String, val country: String, val coordinates: GeoLocation, val timeZone: String, val lastUpdated: String, val publishAllowedTo: List<PublishTokenType>? = emptyList(), val name: String? = null, val postalCode: String? = null, val state: String? = null, val relatedLocations: List<AdditionalGeoLocation> = emptyList(), val parkingType: String? = null, val evses: List<Evse> = emptyList(), val directions: List<DisplayText> = emptyList(), val cpoOperator: BusinessDetails? = null, val subOperator: BusinessDetails? = null, val owner: BusinessDetails? = null, val facilities: List<String> = emptyList(), val openingTimes: Hours? = null, val chargingWhenClosed: Boolean? = null, val images: List<Image> = emptyList(), val energyMix: EnergyMix? = null, val mbxExt: MbxExt? = null)

The Location object describes the location and its properties where a group of EVSEs that belong together are installed.

Parameters

countryCode

ISO-3166 alpha-2 country code of the CPO that 'owns' this Location.

partyId

ID of the CPO that 'owns' this Location (following the ISO-15118 standard).

Uniquely identifies the location within the CPOs platform.

publish

Defines if a Location may be published on an website or app etc.

address

Street/block name and house number if available.

city

City or town.

country

ISO 3166-1 alpha-3 code for the country of this location.

coordinates

Coordinates of the location.

timeZone

One of IANA tzdata’s TZ-values representing the time zone of the location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones)

lastUpdated

Timestamp when this Location or one of its EVSEs or Connectors were last updated (or created).

publishAllowedTo

This field may only be used when the publish field is set to false.

name

Display name of the location.

postalCode

Postal code of the location

state

State or province of the location

relatedLocations

Geographical location of related points relevant to the user.

parkingType

The general type of parking at the charge point location.

evses

List of EVSEs that belong to this Location.

directions

Human-readable directions on how to reach the location.

operator Information of the operator.

subOperator

Information of the sub operator if available.

owner

Information of the owner if available.

facilities

Optional list of facilities this charging location directly belongs to.

openingTimes

The times when the EVSEs at the location can be accessed for charging.

chargingWhenClosed

Indicates if the EVSEs are still charging outside the opening hours of the location.

images

Links to images related to the location such as photos or logos.

energyMix

Details on the energy supplied at this location.

Constructors

Location

constructor(countryCode: String, partyId: String, id: String, publish: Boolean, address: String, city: String, country: String, coordinates: GeoLocation, timeZone: String, lastUpdated: String, publishAllowedTo: List<PublishTokenType>? = emptyList(), name: String? = null, postalCode: String? = null, state: String? = null, relatedLocations: List<AdditionalGeoLocation> = emptyList(), parkingType: String? = null, evses: List<Evse> = emptyList(), directions: List<DisplayText> = emptyList(), cpoOperator: BusinessDetails? = null, subOperator: BusinessDetails? = null, owner: BusinessDetails? = null, facilities: List<String> = emptyList(), openingTimes: Hours? = null, chargingWhenClosed: Boolean? = null, images: List<Image> = emptyList(), energyMix: EnergyMix? = null, mbxExt: MbxExt? = null)