Sources (3)
country_code · CiString(2) · cardinality 1: ISO-3166 alpha-2 country code of the CPO that 'owns' this Location.
party_id · CiString(3) · cardinality 1: ID of the CPO that 'owns' this Location (following the ISO-15118 standard).
id · CiString(36) · cardinality 1: Uniquely identifies the location within the CPOs platform (and suboperator platforms). This field can never be changed, modified or renamed.
publish · boolean · cardinality 1: Defines if a Location may be published on an website or app etc. When this is set to `false`, only tokens identified in the field: `publish_allowed_to` are allowed to be shown this Location. When the same location has EVSEs that may be published and may not be published, two 'Locations' should be created.
publish_allowed_to · PublishTokenType · cardinality *: This field may only be used when the `publish` field is set to `false`. Only owners of Tokens that match all the set fields of one PublishToken in the list are allowed to be shown this location.
name · string(255) · cardinality ?: Display name of the location.
address · string(255) · cardinality 1: Street/block name and house number if available.
city · string(45) · cardinality 1: City or town.
postal_code · string(10) · cardinality ?: Postal code of the location, may only be omitted when the location has no postal code: in some countries charging locations at highways don't have postal codes.
state · string(45) · cardinality ?: State or province of the location, only to be used when relevant.
country · string(3) · cardinality 1: ISO 3166-1 alpha-3 code for the country of this location.
coordinates · GeoLocation · cardinality 1: Coordinates of the location.
related_locations · AdditionalGeoLocation · cardinality *: Geographical location of related points relevant to the user.
parking_type · ParkingType · cardinality ?: The general type of parking at the charge point location.
evses · EVSE · cardinality *: List of EVSEs that belong to this Location.
directions · DisplayText · cardinality *: Human-readable directions on how to reach the location.
operator · BusinessDetails · cardinality ?: Information of the operator. When not specified, the information retrieved from the Credentials module, selected by the `country_code` and `party_id` of this Location, should be used instead.
suboperator · BusinessDetails · cardinality ?: Information of the suboperator if available.
owner · BusinessDetails · cardinality ?: Information of the owner if available.
facilities · Facility · cardinality *: Optional list of facilities this charging location directly belongs to.
time_zone · string(255) · cardinality 1: 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[http://www.iana.org/time-zones])
opening_times · Hours · cardinality ?: The times when the EVSEs at the location can be accessed for charging.
charging_when_closed · boolean · cardinality ?: Indicates if the EVSEs are still charging outside the opening hours of the location. E.g. when the parking garage closes its barriers over night, is it allowed to charge till the next morning? Default: *true*
images · Image · cardinality *: Links to images related to the location such as photos or logos.
energy_mix · EnergyMix · cardinality ?: Details on the energy supplied at this location.
last_updated · DateTime · cardinality 1: Timestamp when this Location or one of its EVSEs or Connectors were last updated (or created).OCPI 2.2.1 specification · #mod_locations_location_objectuid · CiString(36) · cardinality 1: Uniquely identifies the EVSE within the CPOs platform (and suboperator platforms). This field can never be changed, modified or renamed. This is the 'technical' identification of the EVSE, not to be used as 'human readable' identification, use the field `evse_id` for that. This field is named `uid` instead of `id`, because `id` could be confused with `evse_id` which is an eMI3 defined field. Note that in order to fulfill both the requirement that an EVSE's `uid` be unique within a CPO's platform and the requirement that EVSEs are never deleted, a CPO will typically want to avoid using identifiers of the physical hardware for this `uid` property. If they do use such a physical identifier, they will find themselves breaking the uniqueness requirement for `uid` when the same physical EVSE is redeployed at another Location.
evse_id · CiString(48) · cardinality ?: Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (https://web.archive.org/web/20230603153631/https://emi3group.com/documents-links/[https://web.archive.org/web/20230603153631/https://emi3group.com/documents-links/]) "Part 2: business objects." Optional because: if an `evse_id` is to be re-used in the real world, the `evse_id` can be removed from an EVSE object if the `status` is set to `REMOVED`.
status · Status · cardinality 1: Indicates the current status of the EVSE.
status_schedule · StatusSchedule · cardinality *: Indicates a planned status update of the EVSE.
capabilities · Capability · cardinality *: List of functionalities that the EVSE is capable of.
connectors · Connector · cardinality +: List of available connectors on the EVSE.
floor_level · string(4) · cardinality ?: Level on which the Charge Point is located (in garage buildings) in the locally displayed numbering scheme.
coordinates · GeoLocation · cardinality ?: Coordinates of the EVSE.
physical_reference · string(16) · cardinality ?: A number/string printed on the outside of the EVSE for visual identification.
directions · DisplayText · cardinality *: Multi-language human-readable directions when more detailed information on how to reach the EVSE from the _Location_ is required.
parking_restrictions · ParkingRestriction · cardinality *: The restrictions that apply to the parking spot.
images · Image · cardinality *: Links to images related to the EVSE such as photos or logos.
last_updated · DateTime · cardinality 1: Timestamp when this EVSE or one of its Connectors was last updated (or created).OCPI 2.2.1 specification · #mod_locations_evse_objectid · CiString(36) · cardinality 1: Identifier of the Connector within the EVSE. Two Connectors may have the same id as long as they do not belong to the same _EVSE_ object.
standard · ConnectorType · cardinality 1: The standard of the installed connector.
format · ConnectorFormat · cardinality 1: The format (socket/cable) of the installed connector.
power_type · PowerType: 1
max_voltage · int · cardinality 1: Maximum voltage of the connector (line to neutral for AC_3_PHASE), in volt [V]. For example: DC Chargers might vary the voltage during charging when battery almost full.
max_amperage · int · cardinality 1: Maximum amperage of the connector, in ampere [A].
max_electric_power · int · cardinality ?: Maximum electric power that can be delivered by this connector, in Watts (W). When the maximum electric power is lower than the calculated value from `voltage` and `amperage`, this value should be set. For example: A DC Charge Point which can delivers up to 920V and up to 400A can be limited to a maximum of 150kW (max_electric_power = 150000). Depending on the car, it may supply max voltage or current, but not both at the same time. For AC Charge Points, the amount of phases used can also have influence on the maximum power.
tariff_ids · CiString(36) · cardinality *: Identifiers of the currently valid charging tariffs. Multiple tariffs are possible, but only one of each Tariff.type can be active at the same time. Tariffs with the same type are only allowed if they are not active at the same time: start_date_time and end_date_time period not overlapping. When preference-based smart charging is supported, one tariff for every possible ProfileType should be provided. These tell the user about the options they have at this Connector, and what the tariff is for every option. For a "free of charge" tariff, this field should be set and point to a defined "free of charge" tariff.
terms_and_conditions · URL · cardinality ?: URL to the operator's terms and conditions.
last_updated · DateTime · cardinality 1: Timestamp when this Connector was last updated (or created).OCPI 2.2.1 specification · #mod_locations_connector_object