Charging stations: reservations (beta)
No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.
Reserve charging stations by OCPP identity before they connect, follow each reservation through admission and setup, and release them. This API is in preview; fields and values may be added.
List Reservations
The status feed of the caller's reservations, the most recently updated first. ids (reservation ids) or ocppIdentities (every reservation of each identity) selects up to 100, as one value or a repeated parameter; pass one of them, not both. skip and limit (default 100, up to 500) page the result, and meta carries total, skip and limit. An application token reads the reservations made through its installation, a user token every reservation of the account in its provider. Each item is a reservation: state (reserved, admitted, released, expired, retired, rejected) with its dates, rejection { reason, message } for a rejected item, and the state of the charging station under chargingStation. evseControllerId and chargingStation are null before admission; a reserved item that an EVSE controller was attached to carries both. chargingStation is also null once the EVSE controller is deleted or handed over to another installer. owner is null without an owner email and once the reservation ended. States, step keys and every other enumerated value are open sets: accept values added later. Released, expired, retired and rejected items stay listed for 30 days.
User sessionevse-controllers-maintenance:readchargers:reserveQuery parameters4
Exactly these reservations, by the id the reservation response returned. Up to 100.
Exactly these charging stations: every reservation of the caller for each OCPP identity. Up to 100. A percent-encoded identity is decoded once.
Page size, up to 500.
Items to skip.
200The reservations, with the paging in meta application/json
dataChargingStationReservationItem[]
When the reservation was admitted, for an admitted or retired reservation.
The batch the reservation was made in, so a site can be grouped from the feed alone.
chargingStationChargingStationFeedStateREQUIREDThe state of the charging station, whenever the item has a live EVSE controller: an admitted item, or a reserved item that an EVSE controller was attached to. Null before admission, after the EVSE controller is deleted, and once the EVSE controller moved to another installer.
The state of the charging station, whenever the item has a live EVSE controller: an admitted item, or a reserved item that an EVSE controller was attached to. Null before admission, after the EVSE controller is deleted, and once the EVSE controller moved to another installer.
An open set: connected, disconnected, maybeConnected, accessDenied, unknown and pendingFirstConnection today. Accept values added later.
hardwareChargingStationFeedHardwareREQUIREDNull until the charging station sent a boot notification.
Null until the charging station sent a boot notification.
The canonical operational status. An open set: onboarding, activation, live, outOfService and archived today. Accept values added later. Null when the EVSE controller has none.
setupChargingStationFeedSetupREQUIRED
True exactly when the installer must do something; nextStep names the step.
The step that needs the installer, or null.
An open set: pending, inProgress, completed, actionNeeded and failed. Follows connectorSetup alone; autoConfiguration is information only.
The EVSE controller id. Null until e-flux admits the reservation or attaches an EVSE controller to it: a null value is not an error.
The end of the hold, for a reserved or expired reservation.
The reservation id, which GET and DELETE /reservations/{id} take.
linksobjectREQUIREDThe reservation's page in the onboarding overview of the provider's dashboard.
The reservation's page in the onboarding overview of the provider's dashboard.
ownerChargingStationReservationOwnerItemREQUIREDNull when no owner email was given, once the reservation ended, and for a caller that did not supply the email.
Null when no owner email was given, once the reservation ended, and for a caller that did not supply the email.
invitationobjectREQUIRED
An open set: pending, sent, accepted and failed. Accept values added later.
Free text from the reservation request, echoed back.
rejectionChargingStationReservationRejectionItemPresent only for a rejected item.
Present only for a rejected item.
An open set: invalidIdentity, duplicateInRequest, activeForCustomer, identityInUse and archived today. Accept values added later.
When the reservation was released or retired.
When the charging station was reserved. For a rejected item, when the attempt was refused.
reservedByobjectREQUIREDWho reserved; userId is null once a retired reservation lost its details.
Who reserved; userId is null once a retired reservation lost its details.
An open set: reserved, admitted, released, expired, retired and rejected today; waiting and blocklisted are planned. Accept values added later.
The last change of the reservation. Changes of the charging station state do not move it.
metaChargingStationReservationFeedMeta
How many items the query matches.
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Reserve Charging Stations
Reserves charging stations for the caller's account, so that each one joins the account when it connects. Every item gets an outcome: reserved, alreadyReserved (another reservation holds the identity; only its id is returned) or rejected with rejection { reason, message }, the reason being invalidIdentity, duplicateInRequest, activeForCustomer, identityInUse or archived. Outcomes and reasons are open sets. A repeated request answers alreadyReserved and reserves nothing twice. With an application token the token needs the chargers:reserve scope.
User sessionevse-controllers-maintenance:writechargers:reserveRequest bodyapplication/json
chargingStationsobject[]REQUIREDThe charging stations to reserve, 1 to 100. One charging station is an array of one.
The charging stations to reserve, 1 to 100. One charging station is an array of one.
OCPP identity as the charging station presents it on the WebSocket path: 2 to 48 characters of A-Z, a-z, 0-9 and *-_=:+|@. A percent-encoded identity is decoded once.
The end customer to invite once the charging station is configured.
Free text, echoed back.
Serial number, copied onto the EVSE controller at admission.
200One outcome per charging station, in request order application/json
dataReserveChargingStationsItem[]
The identity as the request gave it.
An open set: reserved, alreadyReserved and rejected today. Accept values added later.
rejectionChargingStationReservationRejectionItemPresent only for a rejected item.
Present only for a rejected item.
An open set: invalidIdentity, duplicateInRequest, activeForCustomer, identityInUse and archived today. Accept values added later.
Reserved: the reservation. Already reserved: only the id of the reservation that holds the identity.
metaReserveChargingStationsMeta
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
503The reservation store is unavailable; repeat the request application/json
errorobject
Get a Reservation
One reservation of the caller, by its id. Each item is a reservation: state (reserved, admitted, released, expired, retired, rejected) with its dates, rejection { reason, message } for a rejected item, and the state of the charging station under chargingStation. evseControllerId and chargingStation are null before admission; a reserved item that an EVSE controller was attached to carries both. chargingStation is also null once the EVSE controller is deleted or handed over to another installer. owner is null without an owner email and once the reservation ended. States, step keys and every other enumerated value are open sets: accept values added later. Released, expired, retired and rejected items stay listed for 30 days.
User sessionevse-controllers-maintenance:readchargers:reservePath parameters1
The reservation id, as the reservation response returned it
200The reservation application/json
dataChargingStationReservationItem
When the reservation was admitted, for an admitted or retired reservation.
The batch the reservation was made in, so a site can be grouped from the feed alone.
chargingStationChargingStationFeedStateREQUIREDThe state of the charging station, whenever the item has a live EVSE controller: an admitted item, or a reserved item that an EVSE controller was attached to. Null before admission, after the EVSE controller is deleted, and once the EVSE controller moved to another installer.
The state of the charging station, whenever the item has a live EVSE controller: an admitted item, or a reserved item that an EVSE controller was attached to. Null before admission, after the EVSE controller is deleted, and once the EVSE controller moved to another installer.
An open set: connected, disconnected, maybeConnected, accessDenied, unknown and pendingFirstConnection today. Accept values added later.
hardwareChargingStationFeedHardwareREQUIREDNull until the charging station sent a boot notification.
Null until the charging station sent a boot notification.
The canonical operational status. An open set: onboarding, activation, live, outOfService and archived today. Accept values added later. Null when the EVSE controller has none.
setupChargingStationFeedSetupREQUIRED
True exactly when the installer must do something; nextStep names the step.
The step that needs the installer, or null.
An open set: pending, inProgress, completed, actionNeeded and failed. Follows connectorSetup alone; autoConfiguration is information only.
The EVSE controller id. Null until e-flux admits the reservation or attaches an EVSE controller to it: a null value is not an error.
The end of the hold, for a reserved or expired reservation.
The reservation id, which GET and DELETE /reservations/{id} take.
linksobjectREQUIREDThe reservation's page in the onboarding overview of the provider's dashboard.
The reservation's page in the onboarding overview of the provider's dashboard.
ownerChargingStationReservationOwnerItemREQUIREDNull when no owner email was given, once the reservation ended, and for a caller that did not supply the email.
Null when no owner email was given, once the reservation ended, and for a caller that did not supply the email.
invitationobjectREQUIRED
An open set: pending, sent, accepted and failed. Accept values added later.
Free text from the reservation request, echoed back.
rejectionChargingStationReservationRejectionItemPresent only for a rejected item.
Present only for a rejected item.
An open set: invalidIdentity, duplicateInRequest, activeForCustomer, identityInUse and archived today. Accept values added later.
When the reservation was released or retired.
When the charging station was reserved. For a rejected item, when the attempt was refused.
reservedByobjectREQUIREDWho reserved; userId is null once a retired reservation lost its details.
Who reserved; userId is null once a retired reservation lost its details.
An open set: reserved, admitted, released, expired, retired and rejected today; waiting and blocklisted are planned. Accept values added later.
The last change of the reservation. Changes of the charging station state do not move it.
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404The caller holds no reservation with this id application/json
errorobject
500Internal server error application/json
errorobject
Release a Reservation
Releases a reserved reservation of the caller's account and frees its identity, or dismisses a rejected item. An admitted, expired or retired reservation, or one being admitted, cannot be released: 409 with error.type RESERVATION_NOT_RELEASABLE.
User sessionevse-controllers-maintenance:writechargers:reservePath parameters1
The reservation id, as the reservation response returned it