CancelReservation
Cancels an existing reservation by id.
- Version
- OCPP 1.6
- Direction
- CSMS → Charge Point
- Feature profile
- Reservation
CancelReservation also exists in OCPP 2.0.1, with a different payload. See the OCPP 2.0.1 version.
The counterpart to ReserveNow. Cancelling releases the connector, which should return to Available and send a StatusNotification saying so.
Request
| Field | Type | Required | Description |
|---|---|---|---|
reservationId | integer | Required | The reservation to cancel. |
json
[2, "19223201", "CancelReservation", {
"reservationId": 77
}]Response
| Field | Type | Required | Description |
|---|---|---|---|
status | CancelReservationStatus | Required | Whether a matching reservation was found and cancelled. |
json
[3, "19223201", {
"status": "Accepted"
}]Values
CancelReservationStatus
| Value | Meaning |
|---|---|
Accepted | The reservation existed and was cancelled. |
Rejected | No reservation with that id exists on this charge point. |
Implementation notes
`Rejected` usually means the reservation already lapsed. Expiry is silent on many chargers, so a CSMS tracking reservations by its own timer will routinely try to cancel one the charger has already dropped. Treat it as success.
Expect a StatusNotification returning the connector to Available after a successful cancellation.