OCPP 2.1 Schemas — Reservation

Functional Block: H

Types Reference: Shared types referenced below are defined in OCPP-2.1-DataTypes.md.
Types used only within this block are documented inline below.

#Messages

ReserveNow (CSMS → CS)
CancelReservation (CSMS → CS)
ReservationStatusUpdate (CS → CSMS)

#ReserveNow

Direction: CSMS → CS

#ReserveNowRequest

Field	Type	Required	Constraints	Description
`expiryDateTime`	string (date-time)	Yes		Date and time at which the reservation expires.
`id`	integer	Yes	min: 0.0	Id of reservation.
`idToken`	IdTokenType	Yes
`connectorType`	string	No	maxLength: 20	This field specifies the connector type. Values defined in Appendix as ConnectorEnumStringType.
`evseId`	integer	No	min: 0.0	This contains ID of the evse to be reserved.
`groupIdToken`	IdTokenType	No
`customData`	CustomDataType	No

Example ReserveNowRequest

{
  "expiryDateTime": "2024-01-15T10:30:00Z",
  "id": 0,
  "idToken": {
    "idToken": "string",
    "type": "string"
  }
}

#ReserveNowResponse

Field	Type	Required
`status`	ReserveNowStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#CancelReservation

Direction: CSMS → CS

#CancelReservationRequest

Field	Type	Required	Constraints	Description
`reservationId`	integer	Yes	min: 0.0	Id of the reservation to cancel.
`customData`	CustomDataType	No

Example CancelReservationRequest

{
  "reservationId": 0
}

#CancelReservationResponse

Field	Type	Required
`status`	CancelReservationStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#ReservationStatusUpdate

Direction: CS → CSMS

#ReservationStatusUpdateRequest

Field	Type	Required	Constraints	Description
`reservationId`	integer	Yes	min: 0.0	The ID of the reservation.
`reservationUpdateStatus`	ReservationUpdateStatusEnumType	Yes
`customData`	CustomDataType	No

Example ReservationStatusUpdateRequest

{
  "reservationId": 0,
  "reservationUpdateStatus": "Expired"
}

#ReservationStatusUpdateResponse

No required fields. An empty {} is a valid response.

#Local Types

Types used only within this block's messages.

#CancelReservationStatusEnumType

This indicates the success or failure of the canceling of a reservation by CSMS.

Value
`Accepted`
`Rejected`

Used in: CancelReservation

#ReservationUpdateStatusEnumType

The updated reservation status.

Value
`Expired`
`Removed`
`NoTransaction`

Used in: ReservationStatusUpdate

#ReserveNowStatusEnumType

This indicates the success or failure of the reservation.

Value
`Accepted`
`Faulted`
`Occupied`
`Rejected`
`Unavailable`

Used in: ReserveNow