ChargeStations API

The ChargeStations APi allows to:

• GET all ChargeStations
• GET a Single ChargeStations
• POST create a ChargeStations
• PUT update a ChargeStations
• PATCH to update single fields of a ChargeStations
• GET the charge station hardware templates
• PUT to create charge station hardware templates

Retrieving Charge Stations (GET)

To retrieve all Charge Stations, use the /chargestations endpoint with the 'date_from' field to narrow the search to objects updated since a specific date.
Note: Changes to the EVSE status will not count towards a last modified event for the Locations, only Location object modificatons.

The/chargestations/{chargestationid} endpoint should be used to retrieve information in real time about a Charge Station. This endpoint should be called when loading a single object.

It is NOT allowed to call the /locations/{locationid} endpoint for all LocationIDs to get real time information.

To retrieve all Charge Stations of a Location, use the Get Chargestations endpoint and query by LocationId.

Creating a Charge Station

In order to create a Charge Station, the following fields are required:

• a Location needs to be provided as the parent object. The Location will determine the CPO it is created in.
• Charge station ID
• default charge station tariff code/id
• deployment state (stock, production, deprecated)
• EVSE object, either provided manually or as a hardware template

Creating EVSEs

A Charge Station Must have at least one EVSE to be created. There are two ways:

• Using a hardware template
• creating a manual EVSE structure

Creating EVSE structure via Hardware template

We advise creating and managing hardware template via the EvPortal, although APIs are also available.

When creating or updating the Charge Station and including a 'charge_station_template_id' will create the EVSE object based on that template. The template id can be found in the Portal and retrieved via API

NOTE: "directions" and "parking_restrictions" are fields defined at the EVSE level (as OCPI doesn't have a charge station object). However, they are not part of a hardware template as they are Charge Station specific.
To populate these fields, it is required to after creation to Upsert or Patch the EVSE object and include those fields

Creating EVSE manually

It is possible to create a custom EVSE/Connector setup. As long as it is in the valid format, this is possible.

Updating a Charge station

There are two operations to update a charge station:

• PUT which will upsert the fields. Optional fields that are not supplied will be cleared for the Charge Station
• PATCH will only update those fields provided.

Etags for updating a Charge Station

To ensure that a Charge Station object is not updated at the same time and creating concurrency problems, we have introduced etag

"etag": "ca3a9cab-f785-4624-b0fa-90085e509f70",

When updating (PUT) a Charge Station, then the etag MUST be provided. This can be retrieved from any of the GET calls

For PATCH updates, an etag is not required

📘

etag creation

etags are only created once an object has been updated. In case an etag is not available, please re-save the object.

Charge Station configuration

Essential configuration parameters are made available via the Charge Station object. In the future a separate API will be provided to read all configuration.

All of these configuration fields are Read-only.

"heartbeat_interval": 120,
"charge_point_model": "Dual Power",
"charge_point_vendor": "Alfen",
"charge_point_serial_number": "511845324534324383",
"charge_box_serial_number": "51184532452343483",
"client_ip_address": "95.128.10.19",
"firmware_version": "2.1.4.0",
"iccid": "8945232341876536",
"imsi": "23802623232653",
"meter_serial_number": "unknown",
"meter_type": "unknown",
"remote_manageable": true,
"connectivity_status": "Online",
"protocol_version": "Ocpp16",
"endpoint": "ws://ocpp-public-a.greenflux.com"

Field parameter options

deploy_state:

• Stock
• Production
• Deprecated

status (charge station/evse/connector/schedule):

• AVAILABLE
• BLOCKED
• CHARGING
• INOPERATIVE
• OUTOFORDER
• PLANNED
• REMOVED
• RESERVED
• UNKNOWN

capabilities:

• CREDIT_CARD_PAYABLE
• REMOTE_START_STOP_CAPABLE
• RFID_READER

connectors - standard/format/internal:

standard format internal

IEC_62196_T1_COMBO CABLE CCS1_Cable
IEC_62196_T2_COMBO CABLE CCS2_Cable
IEC_62196_T1_COMBO SOCKET CCS1_Socket
IEC_62196_T2_COMBO SOCKET CCS2_Socket
IEC_62196_T2 SOCKET Mennekes_Socket
IEC_62196_T2 CABLE Mennekes_Cable
IEC_62196_T1 CABLE Type1_Cable
CHADEMO CABLE ChaDeMo_Cable
DOMESTIC_E SOCKET DOMESTIC_E_Socket
DOMESTIC_F SOCKET DOMESTIC_F_Socket
DOMESTIC_G SOCKET DOMESTIC_G_Socket
DOMESTIC_H SOCKET DOMESTIC_H_Socket
DOMESTIC_I SOCKET DOMESTIC_I_Socket
DOMESTIC_J SOCKET DOMESTIC_J_Socket
DOMESTIC_K SOCKET DOMESTIC_K_Socket
DOMESTIC_L SOCKET DOMESTIC_L_Socket

power_type:

• AC_1_PHASE
• AC_3_PHASE
• DC

contactless_type:

• Payter
• Nayax

charger_type:

• Public
• Home
• Business

connectivity_status:

• Online
• Offline