Cancel Reservation
Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.3 (Messages); Use Case H02 — Cancel Reservation (Functional Block H. Reservation)
Overview
The CSMS sends CancelReservationRequest to cancel an active reservation on the Charging Station. The CS replies with status Accepted if a reservation matching reservationId exists; otherwise Rejected.
Sequence Diagram
CSMS ──── CancelReservationRequest ────▶ Charging Station
(reservationId)
CSMS ◀─── CancelReservationResponse ──── Charging Station
(status, statusInfo?)
Initiator
CSMS → Charging Station
Fields
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| reservationId | integer | 1..1 | Required. Id of the reservation to cancel. |
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| status | CancelReservationStatusEnumType | 1..1 | Required. Success or failure of cancelling the reservation. |
| statusInfo | StatusInfoType | 0..1 | Optional. Detailed status information. |
CancelReservationStatusEnumType values
Accepted, Rejected.
Examples
{
"reservationId": 42
}{
"status": "Accepted"
}Schema
Source:
schemas/CancelReservationRequest.json,schemas/CancelReservationResponse.json(OCPP 2.0.1 FINAL)