VDV 463 WebSocket API - CMS Endpoint 1.0.0

VDV 463 WebSocket interactions where the CMS hosts the endpoint. The current runtime fully handles BootNotification and ProvideChargingRequests requests and documents the intended ProvideChargingInformation update flow for future implementation.

Connection summary:

  • Roles: CMS acts as the WebSocket server, upstream presystems act as clients.
  • Runtime endpoint: /vdv463/ws; deployments are expected to expose this as secure WebSocket (TLS 1.2+).
  • Standard expectations: clients should offer Sec-WebSocket-Protocol: v1.463.vdv.de and authenticate via HTTP Basic during the handshake, but the current FastAPI route documents rather than enforces those requirements.
  • Message envelope: named JSON object with messageType, source, presystemId, timeStamp, messageId, messageAction, and payload fields.
  • Helper utilities: MessageStructure.from_socket_list() and .to_socket_list() can convert to or from the seven-slot array shorthand used in some sequence examples.
  • Message types: 1=Request, 2=Confirmation, 3=Error; confirmations echo the request's messageId and messageAction.

Operations

  • RECEIVE /vdv463/ws

    WebSocket channel hosted by the CMS.

    CMS receives BootNotification requests from upstream presystems and acknowledges them.

    Operation IDBootNotification

    Accepts the following message:

    BootNotification Request

    Boot notification initiated by an upstream presystem.

    Message IDBootNotification
    object [BootNotificationRequestEnvelope]

    Examples

  • SEND /vdv463/ws

    WebSocket channel hosted by the CMS.

    CMS sends BootNotification confirmations back to the presystem. Accepted or rejected. Response uses the same MessageId, PresystemId and MessageAction as the Request

    Operation IDBootNotificationConfirmation

    Accepts the following message:

    BootNotification Confirmation

    Confirmation returned by the CMS for BootNotification.

    Message IDBootNotificationConfirmation
    object [BootNotificationConfirmationEnvelope]

    Examples

  • RECEIVE /vdv463/ws

    WebSocket channel hosted by the CMS.

    CMS ingests the list of charging requests published by an upstream system and returns a confirmation.

    Operation IDProvideChargingRequests

    Accepts the following message:

    ProvideChargingRequests Request

    ProvideChargingRequests list published by the upstream presystem.

    Message IDProvideChargingRequests
    object [ProvideChargingRequestsRequestEnvelope]

    Examples

  • SEND /vdv463/ws

    WebSocket channel hosted by the CMS.

    CMS acknowledges charging request lists with a confirmation message. Response uses the same MessageId, PresystemId and MessageAction as the Request

    Operation IDProvideChargingRequestsConfirmation

    Accepts the following message:

    ProvideChargingRequests Confirmation

    Confirmation returned by the CMS for ProvideChargingRequests.

    Message IDProvideChargingRequestsConfirmation
    object [ProvideChargingRequestsConfirmationEnvelope]

    Examples

  • SEND /vdv463/ws

    WebSocket channel hosted by the CMS.

    CMS publishes ProvideChargingInformation updates towards the upstream system and expects an acknowledgement. Generates a new MessageId for each update.

    Operation IDProvideChargingInformation

    Accepts the following message:

    ProvideChargingInformation Update

    Charging infrastructure information initiated by the CMS.

    Message IDProvideChargingInformation
    object [ProvideChargingInformationRequestEnvelope]

    Examples

  • RECEIVE /vdv463/ws

    WebSocket channel hosted by the CMS.

    CMS receives acknowledgements after publishing charging information updates. Response uses the same MessageId, PresystemId and MessageAction as the Request.

    Operation IDProvideChargingInformationConfirmation

    Accepts the following message:

    ProvideChargingInformation Confirmation

    Confirmation expected from the upstream system after receiving an update.

    Message IDProvideChargingInformationConfirmation
    object [ProvideChargingInformationConfirmationEnvelope]

    Examples

Messages

  • #1BootNotification Request

    Boot notification initiated by an upstream presystem.

    Message IDBootNotificationRequest
    object [BootNotificationRequestEnvelope]
  • #2BootNotification Confirmation

    Confirmation returned by the CMS for BootNotification.

    Message IDBootNotificationConfirmation
    object [BootNotificationConfirmationEnvelope]
  • #3ProvideChargingRequests Request

    ProvideChargingRequests list published by the upstream presystem.

    Message IDProvideChargingRequestsRequest
    object [ProvideChargingRequestsRequestEnvelope]
  • #4ProvideChargingRequests Confirmation

    Confirmation returned by the CMS for ProvideChargingRequests.

    Message IDProvideChargingRequestsConfirmation
    object [ProvideChargingRequestsConfirmationEnvelope]
  • #5ProvideChargingInformation Update

    Charging infrastructure information initiated by the CMS.

    Message IDProvideChargingInformationRequest
    object [ProvideChargingInformationRequestEnvelope]
  • #6ProvideChargingInformation Confirmation

    Confirmation expected from the upstream system after receiving an update.

    Message IDProvideChargingInformationConfirmation
    object [ProvideChargingInformationConfirmationEnvelope]

Schemas

  • object [BootNotificationRequestEnvelope]
  • object [BootNotificationRequest]

    Boot Notification Request.

  • string

    Presystem Enum Type.

  • object [BootNotificationConfirmationEnvelope]
  • object [BootNotificationResponse]

    Boot Notification Response.

  • string

    Boot Notification Status Enum.

  • object [ProvideChargingRequestsRequestEnvelope]
  • object [AutomaticPreconditioning]

    Automatic Preconditioning.

  • string

    Charging Instruction Enum.

  • object [ChargingRequest]

    Charging Request.

  • object [ChargingRequestData]

    Charging Request Data.

  • object [ManualPreconditioning]

    Manual Preconditioning.

  • string

    Preconditioning Request Enum.

  • object [ProvideChargingRequestsRequest]

    Provide Charging Requests Request.

  • object [ProvideChargingRequestsConfirmationEnvelope]
  • object [ProvideChargingRequestsResponse]

    Provide Charging Requests Response.

  • object [ProvideChargingInformationRequestEnvelope]
  • string

    Charging Point Fault Code Enum.

  • object [ChargingPointFaultInfo]

    Charging Point Fault Info.

  • object [ChargingPointInfo]

    Charging Point Info.

  • string

    Charging Point Status Enum.

  • object [ChargingPredictionData]

    Charging Prediction Data.

  • object [ChargingPredictionDataDepartureTime]

    Charging Prediction Data Departure Time.

  • object [ChargingPredictionDataFinalSoc]

    Charging Prediction Data Final SoC.

  • object [ChargingPredictionDataMinSoc]

    Charging Prediction Data Min SoC.

  • object [ChargingProcessInfo]

    Charging Process Info.

  • string

    Charging Station Fault Code Enum.

  • object [ChargingStationFaultInfo]

    Charging Station Fault Info.

  • object [ChargingStationInfo]

    Charging Station Info.

  • string

    Charging Station Status Enum.

  • object [DepotInfo]

    Depot Info.

  • object [ElectricData]

    Electric Data.

  • object [H2TankInfo]

    H2 Tank Info.

  • string

    Health Status Enum.

  • object [PreconditioningInfo]

    Preconditioning Info.

  • string

    Process Status Enum.

  • object [ProvideChargingInformationRequest]

    Provide Charging Information Request.

  • object [ScheduledChargingProcess]

    Scheduled Charging Process.

  • object [TractionBatteryInfo]

    Traction Battery Info.

  • string

    Vehicle Charging Status Enum.

  • object [VehicleFaultInfo]

    Vehicle Fault Info.

  • object [VehicleInfo]

    Vehicle Info.

  • object [VehicleStatusInfo]

    Vehicle Status Info.

  • object [ProvideChargingInformationConfirmationEnvelope]
  • object [ProvideChargingInformationResponse]

    Provide Charging Information Response.

  • object [ErrorResponseEnvelope]
  • object [ErrorResponse]

    Error Response.

  • string

    VDV 463 Error Codes.

  • string

    VDV 463 Error Detail.