API Reference

Create a new temporary EVSE status

This API allows operators to temporarily set the displayed EVSE status in e-mobility apps on Spirii's network and roaming networks.

Note: The status set via this API is for display purposes only and does not affect the charger's actual status.

The status is set per EVSE. To change the status for an entire location, you must update each EVSE individually (bulk updates are not currently supported).
The default EVSE status is determined by the charger's OCPP communication (e.g., 'Available', 'Charging').

Intended Use Cases

  • Maintenance: Use this status when an EVSE is undergoing maintenance and should not be used by customers.
  • Commissioning: Use this status for EVSEs that are being set up or tested and are not yet ready for public use.
  • Blocking: Use this status to temporarily prevent an EVSE from being used, for example, due to a fault or safety concern.
  • Reservation: Use this status to indicate that an EVSE is reserved for a specific user or time period.

Status Mapping Across Protocols

When these temporary EVSE statuses are set, they will appear on Spirii's, Hubject, and OCPI eMSP apps as follows:

Temporary StatusSpirii Go AppRoaming on HubjectRoaming on OCPI
MaintenanceUnavailableOut of ServiceInoperative
CommissioningComing SoonOut of ServicePlanned
BlockedBlockedOccupiedBlocked
ReservedReservedReservedReserved
------------------------------------------------------------------------
Delay to eMSP AppsInstantMax 1 minuteMax 15 seconds

Note: Spirii cannot control other eMSP Apps. They might not update as quickly as we send them status updates.

Language
Click Try It! to start a request and see the response here!