OCPP 2.0.1 Schemas — Availability

Functional Block: E/F

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

#Messages

ChangeAvailability (CSMS → CS)
UnlockConnector (CSMS → CS)
TriggerMessage (CSMS → CS)

#ChangeAvailability

Direction: CSMS → CS

#ChangeAvailabilityRequest

Field	Type	Required
`operationalStatus`	OperationalStatusEnumType	Yes
`evse`	EVSEType	No
`customData`	CustomDataType	No

Example ChangeAvailabilityRequest

{
  "operationalStatus": "Inoperative"
}

#ChangeAvailabilityResponse

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

#UnlockConnector

Direction: CSMS → CS

#UnlockConnectorRequest

Field	Type	Required	Description
`connectorId`	integer	Yes	This contains the identifier of the connector that needs to be unlocked.
`evseId`	integer	Yes	This contains the identifier of the EVSE for which a connector needs to be unlocked.
`customData`	CustomDataType	No

Example UnlockConnectorRequest

{
  "connectorId": 0,
  "evseId": 0
}

#UnlockConnectorResponse

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

#TriggerMessage

Direction: CSMS → CS

#TriggerMessageRequest

Field	Type	Required
`requestedMessage`	MessageTriggerEnumType	Yes
`evse`	EVSEType	No
`customData`	CustomDataType	No

Example TriggerMessageRequest

{
  "requestedMessage": "BootNotification"
}

#TriggerMessageResponse

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

#Local Types

Types used only within this block's messages.

#ChangeAvailabilityStatusEnumType

This indicates whether the Charging Station is able to perform the availability change.

Value
`Accepted`
`Rejected`
`Scheduled`

Used in: ChangeAvailability

#MessageTriggerEnumType

Type of message to be triggered.

Value
`BootNotification`
`LogStatusNotification`
`FirmwareStatusNotification`
`Heartbeat`
`MeterValues`
`SignChargingStationCertificate`
`SignV2GCertificate`
`StatusNotification`
`TransactionEvent`
`SignCombinedCertificate`
`PublishFirmwareStatusNotification`

Used in: TriggerMessage

#OperationalStatusEnumType

This contains the type of availability change that the Charging Station should perform.

Value
`Inoperative`
`Operative`

Used in: ChangeAvailability

#TriggerMessageStatusEnumType

Indicates whether the Charging Station will send the requested notification or not.

Value
`Accepted`
`Rejected`
`NotImplemented`

Used in: TriggerMessage

#UnlockStatusEnumType

This indicates whether the Charging Station has unlocked the connector.

Value
`Unlocked`
`UnlockFailed`
`OngoingAuthorizedTransaction`
`UnknownConnector`

Used in: UnlockConnector