Charging stations: reservations (beta)

No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.

GET/1/charging-stations/reservations

List Reservations

Authorization
User session
Permissions
evse-controllers-maintenance:read
OAuth
chargers:reserve
Request
Query parameters4
idsstring <uuid>[]
ocppIdentitiesstring[]
limitinteger
skipinteger
Responses
200The reservations, with the paging in meta application/json
dataChargingStationReservationItem[]
admittedAtstring <date-time>
batchIdstringREQUIRED
chargingStationChargingStationFeedStateREQUIRED
connectivitystringREQUIRED
hardwareChargingStationFeedHardwareREQUIRED
firmwareVersionstringREQUIRED
modelstringREQUIRED
vendorstringREQUIRED
lifecyclestringREQUIRED
setupChargingStationFeedSetupREQUIRED
actionNeededbooleanREQUIRED
nextStepstringREQUIRED
statestringREQUIRED
stepsChargingStationFeedSetupStep[]REQUIRED
evseControllerIdstringREQUIRED
expiresAtstring <date-time>
idstringREQUIRED
linksobjectREQUIRED
dashboardstringREQUIRED
ocppIdentitystringREQUIRED
ownerChargingStationReservationOwnerItemREQUIRED
emailstringREQUIRED
invitationobjectREQUIRED
sentAtstring <date-time>
statestringREQUIRED
referencestringREQUIRED
rejectionChargingStationReservationRejectionItem
messagestringREQUIRED
reasonstringREQUIRED
releasedAtstring <date-time>
reservedAtstring <date-time>REQUIRED
reservedByobjectREQUIRED
clientIdstringREQUIRED
userIdstringREQUIRED
serialNumberstringREQUIRED
statestringREQUIRED
updatedAtstring <date-time>REQUIRED
metaChargingStationReservationFeedMeta
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/charging-stations/reservations

Reserve Charging Stations

Authorization
User session
Permissions
evse-controllers-maintenance:write
OAuth
chargers:reserve
Request
Request bodyapplication/json
chargingStationsobject[]REQUIRED
ocppIdentitystringREQUIRED
ownerEmailstring <email> | null
referencestring | null
serialNumberstring | null
Responses
200One outcome per charging station, in request order application/json
dataReserveChargingStationsItem[]
ocppIdentitystringREQUIRED
outcomestringREQUIRED
rejectionChargingStationReservationRejectionItem
messagestringREQUIRED
reasonstringREQUIRED
reservationChargingStationReservationItem | ChargingStationReservationReference
metaReserveChargingStationsMeta
alreadyReservednumberREQUIRED
batchIdstringREQUIRED
rejectednumberREQUIRED
requestednumberREQUIRED
reservednumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
503The reservation store is unavailable; repeat the request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/charging-stations/reservations/{id}

Get a Reservation

Authorization
User session
Permissions
evse-controllers-maintenance:read
OAuth
chargers:reserve
Request
Path parameters1
idstringREQUIRED
Responses
200The reservation application/json
dataChargingStationReservationItem
admittedAtstring <date-time>
batchIdstringREQUIRED
chargingStationChargingStationFeedStateREQUIRED
connectivitystringREQUIRED
hardwareChargingStationFeedHardwareREQUIRED
firmwareVersionstringREQUIRED
modelstringREQUIRED
vendorstringREQUIRED
lifecyclestringREQUIRED
setupChargingStationFeedSetupREQUIRED
actionNeededbooleanREQUIRED
nextStepstringREQUIRED
statestringREQUIRED
stepsChargingStationFeedSetupStep[]REQUIRED
evseControllerIdstringREQUIRED
expiresAtstring <date-time>
idstringREQUIRED
linksobjectREQUIRED
dashboardstringREQUIRED
ocppIdentitystringREQUIRED
ownerChargingStationReservationOwnerItemREQUIRED
emailstringREQUIRED
invitationobjectREQUIRED
sentAtstring <date-time>
statestringREQUIRED
referencestringREQUIRED
rejectionChargingStationReservationRejectionItem
messagestringREQUIRED
reasonstringREQUIRED
releasedAtstring <date-time>
reservedAtstring <date-time>REQUIRED
reservedByobjectREQUIRED
clientIdstringREQUIRED
userIdstringREQUIRED
serialNumberstringREQUIRED
statestringREQUIRED
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404The caller holds no reservation with this id application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/1/charging-stations/reservations/{id}

Release a Reservation

Authorization
User session
Permissions
evse-controllers-maintenance:write
OAuth
chargers:reserve
Request
Path parameters1
idstringREQUIRED
Responses
204Released or dismissed text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404The account holds no reservation with this id application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
409The reservation is admitted, being admitted, expired or retired. error.type is RESERVATION_NOT_RELEASABLE. application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
503The reservation store is unavailable; repeat the request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED