Mutation

Unknown

Fields

id· ID

ID of a review.

station· Station

Station for which a review was provided.

id· ID

Unique ID of a station.

country_code· String

ISO-3166 alpha-2 country code of a station.

party_id· String

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

publish· Boolean

Defines if a location may be published on a website or app etc. When this is set to false, only tokens identified in the field: publish_allowed_to are allowed to show this location. When the same location has EVSEs that may be published and may not be published, two 'locations' should be created.

name· String

Name of a charging station.

address· String

Street/block name and house number if available.

city· String

City or town

postal_code· String

Postal code of a location, may only be omitted when a location has no postal code: in some countries charging locations at highways don’t have postal codes.

state· String

State or province of a location, only to be used when relevant.

country· String

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

coordinates· OCPIGeoLocation

Coordinates of a location.

related_locations· OCPIAdditionalGeoLocation

Geographical location of related points relevant to a user.

parking_type· OCPIParkingType

Type of parking at a charge point location.

evses· EVSE

EVSEs that belong to a station.

uid· String

Uniquely identifies an EVSE within the CPOs platform (and suboperator platforms). For example a database ID or the actual "EVSE ID". 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.

evse_id· String

Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (http://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· OCPIStatus

Indicates the current status of an EVSE.

status_schedule· OCPIStatusSchedule

Indicates a planned status update of a nEVSE.

capabilities· OCPICapability

List of functionalities that an EVSE is capable of.

connectors· Connector

List of available connectors on an EVSE.

id· String

Identifier of a connector within an EVSE. Two connectors may have the same ID as long as they do not belong to the same EVSE object.

standard· ConnectorType

Standard of an installed connector.

CHADEMO

The connector type is CHAdeMO, DC.

DOMESTIC_A

Standard/domestic household, type "A", NEMA 1-15, 2 pins.

DOMESTIC_B

Standard/domestic household, type "B", NEMA 5-15, 3 pins.

DOMESTIC_C

Standard/domestic household, type "C", CEE 7/17, 2 pins.

DOMESTIC_D

Standard/domestic household, type "D", 3 pins.

DOMESTIC_E

Standard/domestic household, type "E", CEE 7/5 3 pins.

DOMESTIC_F

Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.

DOMESTIC_G

Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.

DOMESTIC_H

Standard/domestic household, type "H", SI-32, 3 pins.

DOMESTIC_I

Standard/domestic household, type "I", AS 3112, 3 pins.

DOMESTIC_J

Standard/domestic household, type "J", SEV 1011, 3 pins.

DOMESTIC_K

Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.

DOMESTIC_L

Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.

DOMESTIC_M

Standard/Domestic household, type "M", BS 546, 3 pins.

DOMESTIC_N

Standard/Domestic household, type "N", NBR 14136, 3 pins.

DOMESTIC_O

Standard/Domestic household, type "O", TIS 166-2549, 3 pins.

IEC_60309_2_single_16

IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).

IEC_60309_2_three_16

IEC 60309-2 Industrial connector three phase 16 amperes (usually red).

IEC_60309_2_three_32

IEC 60309-2 Industrial connector three phase 32 amperes (usually red).

IEC_60309_2_three_64

IEC 60309-2 Industrial connector three phase 64 amperes (usually red).

IEC_62196_T1

IEC 62196 Type 1 "SAE J1772".

IEC_62196_T1_COMBO

Combo Type 1 based, DC.

IEC_62196_T2

IEC 62196 Type 2 "Mennekes".

IEC_62196_T2_COMBO

Combo Type 2 based, DC.

IEC_62196_T3A

IEC 62196 Type 3A.

IEC_62196_T3C

IEC 62196 Type 3C "Scame".

PANTOGRAPH_BOTTOM_UP

On-board bottom-up-pantograph typically for bus charging.

PANTOGRAPH_TOP_DOWN

Off-board top-down-pantograph typically for bus charging.

TESLA_R

Tesla connector "Roadster"-type (round, 4 pins).

TESLA_S

Tesla connector "Model-S"-type (oval, 5 pins).

GB_T

The connector type is GB_T (Chinese standard), DC.

CHAOJI

The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.

NEMA_5_20

The connector type is NEMA 5-20, 3 pins.

NEMA_6_30

The connector type is NEMA 6-30, 3 pins.

NEMA_6_50

The connector type is NEMA 6-50, 3 pins.

NEMA_10_30

The connector type is NEMA 10-30, 3 pins.

NEMA_10_50

The connector type is NEMA 10-50, 3 pins.

NEMA_14_30

The connector type is NEMA 14-30, 3 pins, rating of 30 A.

NEMA_14_50

The connector type is NEMA 14-50, 3 pins, rating of 50 A.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

format· OCPIConnectorFormat

Format (socket/cable) of an installed connector.

power_type· OCPIPowerType

Type of power of an installed connector.

max_voltage· Int

Maximum voltage of an 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

Maximum amperage of a connector, in ampere [A].

max_electric_power· Int

Maximum electric power that can be delivered by a connector, in watt [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 deliver up to 920V and up to 400A can be limited to a maximum of 150kW. Depending on the vehicle, it may supply maximum 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.

power· Float

Maximum electric power in kW.

tariff_ids· String

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. This tells 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· String

URL to an operator’s terms and conditions.

last_updated· DateTime

Timestamp when a connector was last updated (or created).

properties· JSON

Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.

tariff· OCPITariff

List of valid charging tariffs.

country_code· String

ISO-3166 alpha-2 country code of the CPO that owns this tariff

party_id· String

CPO ID of the CPO that owns this tariff (following the ISO-15118 standard)

id· String

Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms)

currency· String

ISO-4217 code of the currency of this tariff.

type· OCPITariffType

Defines the type of the tariff. This allows for distinction in case of given charging preferences. When omitted, this tariff is valid for all sessions

tariff_alt_text· OCPIDisplayText

List of alternative tariff information texts, in multiple languages

tariff_alt_url· String

URL to a web page that contains an explanation of the tariff information in human readable form

min_price· OCPIPrice

When this field is set, a charging session with this tariff will cost at least the amount shown. This is different from a FLAT fee (start tariff, transaction fee), as a FLAT fee is a fixed amount that must be paid for any charging session. A minimum price indicates that when the cost of a charging session is lower than this amount, the cost of the session will be equal to this amount

max_price· OCPIPrice

When this field is set, a charging session with this tariff will NOT cost more than this amount

elements· OCPITariffElement

List of tariff elements

price_components· OCPIPriceComponent

List of price components that describe the pricing of a tariff.

restrictions· OCPITariffRestrictions

Restrictions that describe the applicability of a tariff.

start_time· String

Start time of day in local time, the time zone is defined in the time_zone field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]

end_time· String

End time of day in local time, the time zone is defined in the time_zone field of the Location, for example 19:45, valid until this time of the day. Same syntax as start_time.

start_date· String

Start date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-24, valid from this day. Regex: ([12][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])

end_date· String

End date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-27, valid until this day (exclusive). Same syntax as start_date

min_kwh· Float

Minimum consumed energy in kWh, for example 20, valid from this amount of energy being used

max_kwh· Float

Maximum consumed energy in kWh, for example 50, valid until this amount of energy being used

min_current· Float

Sum of the minimum current in over all phases, for example 5. When the EV is charging with more than the defined amount of current, this tariff element is/becomes active. If the charging current is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum current over the entire charging session. This restriction can make a tariff element become active when the charging current is above the defined value, but the tariff element MUST no longer be active when the charging current drops below the defined value

max_current· Float

Sum of the maximum current in over all phases, for example 20. When the EV is charging with less than the defined amount of current, this tariff element becomes/is active. If the charging current is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a tariff element become active when the charging current is below this value, but the tariff element MUST no longer be active when the charging current raises above the defined value

min_power· Float

Minimum power in kW, for example 5. When the EV is charging with more than the defined amount of power, this tariff element is/becomes active. If the charging power is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum power over the entire charging session. This restriction can make a tariff element become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value

max_power· Float

Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this tariff element becomes/is active. If the charging power is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This does not describe the maximum power over the entire charging session. This restriction can make a tariff element become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power raises above the defined value

min_duration· Float

Minimum duration in seconds the charging session MUST last (inclusive). When the duration of a charging session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this tariff element is not yet active

max_duration· Float

Maximum duration in seconds the charging session MUST last (exclusive). When the duration of a charging session is shorter than the defined value, this tariff element is or becomes active. After that moment, this tariff element is no longer active

day_of_week· OCPIDayOfWeek

Which day(s) of the week this tariff element is active.

reservation· OCPIReservationRestrictionType

When this field is present, the tariff element describes reservation costs. A reservation starts when the reservation is made, and ends when the drivers starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation

start_date_time· DateTime

Time when this tariff becomes active, in UTC, time_zone field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active

end_date_time· DateTime

Time after which this tariff is no longer valid, in UTC, time_zone field if the location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff in the near future

energy_mix· OCPIEnergyMix

Details about the energy supplied with this tariff

last_updated· DateTime

Timestamp when this tariff was last updated (or created)

pricing· Pricing· deprecated

Charging prices.

prices· ConnectorPrice

Dynamic charging prices.

external_id· String

ID for the price.

partner· String

Owner of the payment product.

partner_id· String

ID for the owner of the payment product.

product· ConnectorPriceProduct

Payment product.

elements· ConnectorPriceElement

Price product elements.

components· ConnectorPriceElementComponent

Connector price element components.

restrictions· ConnectorPriceElementRestrictions

Connector price element restrictions.

start_time· String

Starting time of the day for the prices.

end_time· String

Ending time of the day for the prices.

start_date· String

Starting date for the prices.

end_date· String

Ending date for the prices.

minimum_kwh· Float

Minimum energy used, in kWh.

maximum_kwh· Float

Maximum energy used, in kWh.

minimum_power· Float

Minimum charging speed, in kW.

maximum_power· Float

Maximum charging speed, in kW.

minimum_current· Float

Sum of the minimum current (in Amperes) over all the phases. When the EV is charging with more than or equal to this value the prices are active. If the charging current is lower, this price is inactive.

maximum_current· Float

Sum of the maximum current (in Amperes) over all the phases. When the EV is charging with less than this value the prices are active. If the charging current is higher, this price is inactive.

minimum_price· Float

Minimum price based on the amount of kWh that is being delivered.

maximum_price· Float

Maximum price based on the amount of kWh that is being delivered.

overstay_battery_percentage· ConnectorPriceRestrictionsOverstayBatteryPercentage

Battery percentage at which the overstay prices are active.

overstay_time· ConnectorPriceRestrictionsOverstayTime

Time after which the overstay prices are active.

minimum_duration· Int

Minimum duration, in seconds.

maximum_duration· Int

Maximum duration, in seconds.

day_of_week· DayOfWeek

Day(s) of the week that the prices are valid.

emsp_contract_date· ConnectorPriceRestrictionsEmspContractDate

Contract signed between the eMSP and the customer.

reservation· ConnectorPriceRestrictionsReservationType

When this field is present, the ConnectorPriceElement describes reservation costs. A reservation starts when the reservation is made, and ends when the driver starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: `flat` and `time` ConnectorPriceElementComponentType, where time is for the duration of the reservation. When a price has both, `reservation` and `reservation_expires` ConnectorPriceElement, where both ConnectorPriceElement have a time ConnectorPriceElementComponent, then the time based cost of an expired reservation will be calculated based on the `reservation_expires` ConnectorPriceElement.

last_updated· DateTime

Indicates when the pricing data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a price update or any other update (for example, pricing type update).

custom_properties· ConnectorCustomProperties

Custom properties of a connector. These are vendor specific and will return null values on the fields that are not supported by your station database.

floor_level· String

Level on which a Charge Point is located (in garage buildings) in the locally displayed numbering scheme.

coordinates· OCPIGeoLocation

Coordinates of a EVSE.

physical_reference· String

A number/string printed on the outside of an EVSE for visual identification.

parking_restrictions· OCPIParkingRestriction

Restrictions that apply to a parking spot.

images· OCPIImage

Links to images related to an EVSE such as photos or logos.

last_updated· DateTime

Timestamp when this EVSE or one of its Connectors was last updated (or created).

parking_cost· ParkingCost

Indicates if parking is free or paid.

cpo_external_id· String

Unique ID of the location in the system of the CPO.

properties· JSON

Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.

custom_properties· EvseCustomProperties

Custom properties of an EVSE.

directions· OCPIDisplayText

Human-readable directions on how to reach a station.

operator· Operator

Information about an operator.

id· ID

Unique operator ID.

external_id· String

External ID of an operator provided by the operator data source.

name· String

Name of an operator.

website· String

Link to an operator’s website.

logo· OCPIImage

Image link to an operator’s logo.

country· String· deprecated

ISO-3166 alpha-2 country code an operator is active in.

countries· CountryCodeAlpha2

ISO-3166 alpha-2 country codes an operator is active in.

contact· Contact

Contact information.

ranking· Int· deprecated

Ranking level on which the operator is placed or null in case the operator is not on any ranking level. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

excluded· Boolean· deprecated

Flag which indicates if the operator is in the excluded list. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

ranking_levels· OperatorRankingLevels

Ranking configuration for the operator. An operator can be ranked on different levels in different countries. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

excluded_countries· CountryCodeAlpha2

List of countries where the operator is excluded. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

avoided_countries· CountryCodeAlpha2

List of countries where the operator is avoided. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

suboperator· Operator

Information about a suboperator if applicable.

id· ID

Unique operator ID.

external_id· String

External ID of an operator provided by the operator data source.

name· String

Name of an operator.

website· String

Link to an operator’s website.

logo· OCPIImage

Image link to an operator’s logo.

country· String· deprecated

ISO-3166 alpha-2 country code an operator is active in.

countries· CountryCodeAlpha2

ISO-3166 alpha-2 country codes an operator is active in.

contact· Contact

Contact information.

ranking· Int· deprecated

excluded· Boolean· deprecated

Flag which indicates if the operator is in the excluded list. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

ranking_levels· OperatorRankingLevels

excluded_countries· CountryCodeAlpha2

List of countries where the operator is excluded. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

avoided_countries· CountryCodeAlpha2

List of countries where the operator is avoided. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

owner· Operator

Information about an owner if available.

id· ID

Unique operator ID.

external_id· String

External ID of an operator provided by the operator data source.

name· String

Name of an operator.

website· String

Link to an operator’s website.

logo· OCPIImage

Image link to an operator’s logo.

country· String· deprecated

ISO-3166 alpha-2 country code an operator is active in.

countries· CountryCodeAlpha2

ISO-3166 alpha-2 country codes an operator is active in.

contact· Contact

Contact information.

ranking· Int· deprecated

excluded· Boolean· deprecated

Flag which indicates if the operator is in the excluded list. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

ranking_levels· OperatorRankingLevels

excluded_countries· CountryCodeAlpha2

List of countries where the operator is excluded. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

avoided_countries· CountryCodeAlpha2

List of countries where the operator is avoided. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

facilities· OCPIFacility

Facilities a charging station belongs to.

time_zone· String

Value from the IANA time zone database representing the time zone of a location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones).

opening_times· OCPIHours

Times when an EVSEs at a location can be accessed for charging.

charging_when_closed· Boolean

Indicates if the EVSEs are still charging outside the opening hours. E.g. when a parking garage closes its barriers overnight, is it allowed to charge till the next morning? Default: true.

images· OCPIImage

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

energy_mix· OCPIEnergyMix

Details of the energy supplied at a location.

last_updated· DateTime

Timestamp when a location, or one of its EVSEs or Connectors were last updated (or created).

external_id· String

ID provided by a station data source.

location· Point

GeoJSON location of a charging station.

elevation· Int

Elevation (altitude) level.

chargers· Charger

Groups of EVSEs by power and type.

standard· ConnectorType

Type of a charger.

CHADEMO

The connector type is CHAdeMO, DC.

DOMESTIC_A

Standard/domestic household, type "A", NEMA 1-15, 2 pins.

DOMESTIC_B

Standard/domestic household, type "B", NEMA 5-15, 3 pins.

DOMESTIC_C

Standard/domestic household, type "C", CEE 7/17, 2 pins.

DOMESTIC_D

Standard/domestic household, type "D", 3 pins.

DOMESTIC_E

Standard/domestic household, type "E", CEE 7/5 3 pins.

DOMESTIC_F

Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.

DOMESTIC_G

Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.

DOMESTIC_H

Standard/domestic household, type "H", SI-32, 3 pins.

DOMESTIC_I

Standard/domestic household, type "I", AS 3112, 3 pins.

DOMESTIC_J

Standard/domestic household, type "J", SEV 1011, 3 pins.

DOMESTIC_K

Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.

DOMESTIC_L

Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.

DOMESTIC_M

Standard/Domestic household, type "M", BS 546, 3 pins.

DOMESTIC_N

Standard/Domestic household, type "N", NBR 14136, 3 pins.

DOMESTIC_O

Standard/Domestic household, type "O", TIS 166-2549, 3 pins.

IEC_60309_2_single_16

IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).

IEC_60309_2_three_16

IEC 60309-2 Industrial connector three phase 16 amperes (usually red).

IEC_60309_2_three_32

IEC 60309-2 Industrial connector three phase 32 amperes (usually red).

IEC_60309_2_three_64

IEC 60309-2 Industrial connector three phase 64 amperes (usually red).

IEC_62196_T1

IEC 62196 Type 1 "SAE J1772".

IEC_62196_T1_COMBO

Combo Type 1 based, DC.

IEC_62196_T2

IEC 62196 Type 2 "Mennekes".

IEC_62196_T2_COMBO

Combo Type 2 based, DC.

IEC_62196_T3A

IEC 62196 Type 3A.

IEC_62196_T3C

IEC 62196 Type 3C "Scame".

PANTOGRAPH_BOTTOM_UP

On-board bottom-up-pantograph typically for bus charging.

PANTOGRAPH_TOP_DOWN

Off-board top-down-pantograph typically for bus charging.

TESLA_R

Tesla connector "Roadster"-type (round, 4 pins).

TESLA_S

Tesla connector "Model-S"-type (oval, 5 pins).

GB_T

The connector type is GB_T (Chinese standard), DC.

CHAOJI

The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.

NEMA_5_20

The connector type is NEMA 5-20, 3 pins.

NEMA_6_30

The connector type is NEMA 6-30, 3 pins.

NEMA_6_50

The connector type is NEMA 6-50, 3 pins.

NEMA_10_30

The connector type is NEMA 10-30, 3 pins.

NEMA_10_50

The connector type is NEMA 10-50, 3 pins.

NEMA_14_30

The connector type is NEMA 14-30, 3 pins, rating of 30 A.

NEMA_14_50

The connector type is NEMA 14-50, 3 pins, rating of 50 A.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

power· Float

Power of a charger, in kW.

price· String

Price of a charger.

speed· StationSpeedType

Charging speed.

status· ChargerStatuses

Statuses of all the EVSEs grouped in a charger.

total· Int

Total number of EVSEs grouped in a charger.

amenities· JSON

Amenities located at this location.

physical_address· Address

Enriched information about the physical address of a station.

heavy_vehicles_properties· StationHeavyVehiclesProperties

Describes the heavy vehicle properties at the location.

heavy_vehicles_restrictions· StationHeavyVehiclesRestrictions

Describes the heavy vehicle restrictions at the location.

vehicle_restrictions· StationVehicleRestrictions

Describes the vehicle restrictions at the location.

location_category· String

Type of location where the charge point is located. For example, shop.

entrance_for_navigation· OCPIAdditionalGeoLocation

Coordinates for the location's entrances in decimal degrees. If available, there can be more than one entrances to the location.

properties· JSON· deprecated

Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.

realtime· Boolean

A flag that indicates if a station has real-time information about the availability of its connectors.

power· JSON

Connectors grouped by power.

predicted_occupancy· StationPredictedOccupancy

Predicted station occupancy.

speed· StationSpeedType

Charging speed for a station.

status· ChargerStatus

Global status for a station.

custom_properties· StationCustomProperties

Custom properties of a station. These are vendor specific and will return null values on the fields that are not supported by your station database.

review· ReviewStats

Review of a station.

roaming· StationRoaming

List of eMSP cards accepted at a charging station.

support_phone_number· String

Phone number for assistance at a charging station.

charging_behaviour· ChargingBehaviour

Charging behavior of a station.

reliability_score· Int

Shows how reliable a charging station is (1 to 5; 1 = unreliable, 5 = reliable), taking into account the charging behaviour history and error values.

adhoc_authorisation_payment_method· StationAdhocAuthorisationPaymentMethod

Indicates the authentication and payment methods.

access_type· AccessType

Type of access to the charging station.

boosting_group_ids· ID· beta

List of active boosting groups to which the station belongs.

user· ReviewUser

User who added a review. If a review was added by an anonymous user, this will be null.

rating· Int

Rating of a review.

message· String

Message of a review.

locale· String

Locale of a message.

ev· Vehicle

Vehicle that was provided/selected by a user.

id· ID

Vehicles unique ID.

naming· VehicleNaming

Naming of the vehicle.

drivetrain· VehicleDrivetrain

Drivetrain of the vehicle.

connectors· VehicleConnector

Available connectors for the vehicle. Please note that for HEVs this will always be an empty array.

standard· ConnectorType

Connector type, known as connector standard in OCPI.

CHADEMO

The connector type is CHAdeMO, DC.

DOMESTIC_A

Standard/domestic household, type "A", NEMA 1-15, 2 pins.

DOMESTIC_B

Standard/domestic household, type "B", NEMA 5-15, 3 pins.

DOMESTIC_C

Standard/domestic household, type "C", CEE 7/17, 2 pins.

DOMESTIC_D

Standard/domestic household, type "D", 3 pins.

DOMESTIC_E

Standard/domestic household, type "E", CEE 7/5 3 pins.

DOMESTIC_F

Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.

DOMESTIC_G

Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.

DOMESTIC_H

Standard/domestic household, type "H", SI-32, 3 pins.

DOMESTIC_I

Standard/domestic household, type "I", AS 3112, 3 pins.

DOMESTIC_J

Standard/domestic household, type "J", SEV 1011, 3 pins.

DOMESTIC_K

Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.

DOMESTIC_L

Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.

DOMESTIC_M

Standard/Domestic household, type "M", BS 546, 3 pins.

DOMESTIC_N

Standard/Domestic household, type "N", NBR 14136, 3 pins.

DOMESTIC_O

Standard/Domestic household, type "O", TIS 166-2549, 3 pins.

IEC_60309_2_single_16

IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).

IEC_60309_2_three_16

IEC 60309-2 Industrial connector three phase 16 amperes (usually red).

IEC_60309_2_three_32

IEC 60309-2 Industrial connector three phase 32 amperes (usually red).

IEC_60309_2_three_64

IEC 60309-2 Industrial connector three phase 64 amperes (usually red).

IEC_62196_T1

IEC 62196 Type 1 "SAE J1772".

IEC_62196_T1_COMBO

Combo Type 1 based, DC.

IEC_62196_T2

IEC 62196 Type 2 "Mennekes".

IEC_62196_T2_COMBO

Combo Type 2 based, DC.

IEC_62196_T3A

IEC 62196 Type 3A.

IEC_62196_T3C

IEC 62196 Type 3C "Scame".

PANTOGRAPH_BOTTOM_UP

On-board bottom-up-pantograph typically for bus charging.

PANTOGRAPH_TOP_DOWN

Off-board top-down-pantograph typically for bus charging.

TESLA_R

Tesla connector "Roadster"-type (round, 4 pins).

TESLA_S

Tesla connector "Model-S"-type (oval, 5 pins).

GB_T

The connector type is GB_T (Chinese standard), DC.

CHAOJI

The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.

NEMA_5_20

The connector type is NEMA 5-20, 3 pins.

NEMA_6_30

The connector type is NEMA 6-30, 3 pins.

NEMA_6_50

The connector type is NEMA 6-50, 3 pins.

NEMA_10_30

The connector type is NEMA 10-30, 3 pins.

NEMA_10_50

The connector type is NEMA 10-50, 3 pins.

NEMA_14_30

The connector type is NEMA 14-30, 3 pins, rating of 30 A.

NEMA_14_50

The connector type is NEMA 14-50, 3 pins, rating of 50 A.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

power· Float

Usable electric power.

max_electric_power· Float

Maximum electric power.

time· Int

Time it takes to charge from 10 to 80% with a fast charger, shown in minutes.

speed· Float· deprecated

Charging speed.

charge_speed· Float

Charging speed.

adapters· VehicleConnector

Adapters for the connectors of the vehicle. Please note that for HEVs this will always be an empty array.

standard· ConnectorType

Connector type, known as connector standard in OCPI.

CHADEMO

The connector type is CHAdeMO, DC.

DOMESTIC_A

Standard/domestic household, type "A", NEMA 1-15, 2 pins.

DOMESTIC_B

Standard/domestic household, type "B", NEMA 5-15, 3 pins.

DOMESTIC_C

Standard/domestic household, type "C", CEE 7/17, 2 pins.

DOMESTIC_D

Standard/domestic household, type "D", 3 pins.

DOMESTIC_E

Standard/domestic household, type "E", CEE 7/5 3 pins.

DOMESTIC_F

Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.

DOMESTIC_G

Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.

DOMESTIC_H

Standard/domestic household, type "H", SI-32, 3 pins.

DOMESTIC_I

Standard/domestic household, type "I", AS 3112, 3 pins.

DOMESTIC_J

Standard/domestic household, type "J", SEV 1011, 3 pins.

DOMESTIC_K

Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.

DOMESTIC_L

Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.

DOMESTIC_M

Standard/Domestic household, type "M", BS 546, 3 pins.

DOMESTIC_N

Standard/Domestic household, type "N", NBR 14136, 3 pins.

DOMESTIC_O

Standard/Domestic household, type "O", TIS 166-2549, 3 pins.

IEC_60309_2_single_16

IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).

IEC_60309_2_three_16

IEC 60309-2 Industrial connector three phase 16 amperes (usually red).

IEC_60309_2_three_32

IEC 60309-2 Industrial connector three phase 32 amperes (usually red).

IEC_60309_2_three_64

IEC 60309-2 Industrial connector three phase 64 amperes (usually red).

IEC_62196_T1

IEC 62196 Type 1 "SAE J1772".

IEC_62196_T1_COMBO

Combo Type 1 based, DC.

IEC_62196_T2

IEC 62196 Type 2 "Mennekes".

IEC_62196_T2_COMBO

Combo Type 2 based, DC.

IEC_62196_T3A

IEC 62196 Type 3A.

IEC_62196_T3C

IEC 62196 Type 3C "Scame".

PANTOGRAPH_BOTTOM_UP

On-board bottom-up-pantograph typically for bus charging.

PANTOGRAPH_TOP_DOWN

Off-board top-down-pantograph typically for bus charging.

TESLA_R

Tesla connector "Roadster"-type (round, 4 pins).

TESLA_S

Tesla connector "Model-S"-type (oval, 5 pins).

GB_T

The connector type is GB_T (Chinese standard), DC.

CHAOJI

The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.

NEMA_5_20

The connector type is NEMA 5-20, 3 pins.

NEMA_6_30

The connector type is NEMA 6-30, 3 pins.

NEMA_6_50

The connector type is NEMA 6-50, 3 pins.

NEMA_10_30

The connector type is NEMA 10-30, 3 pins.

NEMA_10_50

The connector type is NEMA 10-50, 3 pins.

NEMA_14_30

The connector type is NEMA 14-30, 3 pins, rating of 30 A.

NEMA_14_50

The connector type is NEMA 14-50, 3 pins, rating of 50 A.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

power· Float

Usable electric power.

max_electric_power· Float

Maximum electric power.

time· Int

Time it takes to charge from 10 to 80% with a fast charger, shown in minutes.

speed· Float· deprecated

Charging speed.

charge_speed· Float

Charging speed.

battery· VehicleBattery

Battery of the vehicle.

body· VehicleBody

Body of the vehicle.

availability· VehicleAvailability

Availability of the vehicle.

performance· VehiclePerformance

Performance of the vehicle.

range· VehicleRange

Range of the vehicle.

media· VehicleMedia

Media of the vehicle.

image· VehicleImage

Featured image of the vehicle from a 45-degree angle.

brand· VehicleImage· deprecated

Latest make logo.

make· VehicleImage

Latest make logo.

image_list· VehicleImage

All images of the vehicle.

video· VehicleVideo

Errors

Operations can fail. To handle all errors correctly, consider implementing the following error scenario’s.

client_auth_mandatory
error_forbidden_message
review_invalid_id
review_not_found
review_remove_not_allowed

Was this helpful?

Unknown

Arguments

Fields

Errors