This API enables you, the Charge Point Operator (CPO)—the owners of chargers and EVSE, data—to temporarily override the displayed status of an EVSE (Electric Vehicle Supply Equipment) in e-mobility apps, without affecting its underlying technical or operational state.
We refer to this as a Temporary EVSE Status. It is designed for scenarios where an EVSE should not be used by customers for a limited period, such as during maintenance, commissioning, reservation, or temporary blocking, but where the EVSE itself remains technically operational.
Key Distinction: Technical vs. Displayed (POI) Status
-
Technical EVSE Status:
The actual operational state of the EVSE, as reported by the charger using protocols like OCPP (e.g., Available, Charging, Faulted). This status reflects the real-time condition and capabilities of the hardware. -
POI (Point of Interest) EVSE Status:
The status shown to end-users in apps and roaming platforms. This can be overridden by this API to communicate temporary unavailability or special conditions, regardless of the technical status.
This API only affects the POI status. Communication with the charger and its technical state (OCPP status) remain unchanged.
Intended Use Cases
- Maintenance: Mark an EVSE as unavailable to users while it is being serviced, even if technically operational.
- Commissioning: Indicate that an EVSE is being set up or tested and not yet open for public use.
- Blocking: Temporarily prevent usage due to faults, safety concerns, or other operational reasons.
- Reservation: Show that an EVSE is reserved for a specific user or time period.
Status Mapping Across Protocols
When a Temporary EVSE Status is set, it is mapped to the corresponding display status in Spirii's app and major roaming platforms as follows:
| Temporary Status | Spirii Go App | Hubject (Roaming) | OCPI (Roaming) |
|---|---|---|---|
| Maintenance | Unavailable | Out of Service | Inoperative |
| Commissioning | Coming Soon | Out of Service | Planned |
| Blocked | Blocked | Occupied | Blocked |
| Reserved | Reserved | Reserved | Reserved |
| Delay to eMSP Apps | Instant | Max 1 minute | Max 15 seconds |
Note: External eMSP (e-mobility service provider) apps may not reflect status changes immediately, as their update intervals can vary.
Once you create a Temporary EVSE Status, you receive a unique resource ID. This ID allows you to update (PATCH) the status (e.g., change the type or adjust the validFrom/validTo dates) or delete it to revert the EVSE back to its technical status. In other words, this is a full CRUD resource for managing temporary display statuses.