VDV 463 WebSocket API - CMS Endpoint 1.0.0

VDV 463 WebSocket interactions where the CMS hosts the endpoint, receives BootNotification and ProvideChargingRequests messages, and publishes ProvideChargingInformation updates.

Connection summary:

  • Roles: CMS acts as the secure WebSocket server, upstream presystems act as clients.
  • Endpoint: secure WebSocket (TLS 1.2+) `wss://. NOTE: exact endpoint depends on region and configuration.
  • Subprotocol: clients must offer Sec-WebSocket-Protocol: v1.463.vdv.de; the CMS selects the highest match.
  • Authentication: upstream systems authenticate via HTTP Basic during the handshake; the CMS authenticates with its TLS certificate.
  • Message envelope: 7-field positional JSON array [messageType, source, presystemId, timeStamp, messageId, messageAction, payload].
  • 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 RequestBootNotification

    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 ConfirmationBootNotificationConfirmation

    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 RequestProvideChargingRequests

    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 ConfirmationProvideChargingRequestsConfirmation

    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 UpdateProvideChargingInformation

    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, PressystemId and MessageAction as the Request

    Operation IDProvideChargingInformationConfirmation

    Accepts the following message:

    ProvideChargingInformation ConfirmationProvideChargingInformationConfirmation

    Confirmation expected from the upstream system after receiving an update.

    Message IDProvideChargingInformationConfirmation
    object [ProvideChargingInformationConfirmationEnvelope]

    Examples

Messages

  • #1BootNotification RequestBootNotificationRequest

    Boot notification initiated by an upstream presystem.

    Message IDBootNotificationRequest
    object [BootNotificationRequestEnvelope]
  • #2BootNotification ConfirmationBootNotificationConfirmation

    Confirmation returned by the CMS for BootNotification.

    Message IDBootNotificationConfirmation
    object [BootNotificationConfirmationEnvelope]
  • #3ProvideChargingRequests RequestProvideChargingRequestsRequest

    ProvideChargingRequests list published by the upstream presystem.

    Message IDProvideChargingRequestsRequest
    object [ProvideChargingRequestsRequestEnvelope]
  • #4ProvideChargingRequests ConfirmationProvideChargingRequestsConfirmation

    Confirmation returned by the CMS for ProvideChargingRequests.

    Message IDProvideChargingRequestsConfirmation
    object [ProvideChargingRequestsConfirmationEnvelope]
  • #5ProvideChargingInformation UpdateProvideChargingInformationRequest

    Charging infrastructure information initiated by the CMS.

    Message IDProvideChargingInformationRequest
    object [ProvideChargingInformationRequestEnvelope]
  • #6ProvideChargingInformation ConfirmationProvideChargingInformationConfirmation

    Confirmation expected from the upstream system after receiving an update.

    Message IDProvideChargingInformationConfirmation
    object [ProvideChargingInformationConfirmationEnvelope]

Schemas

  • object [BootNotificationRequestEnvelope]
  • object [BootNotificationRequest]

    Boot Notification Request.

  • PresystemEnumType
    string

    Presystem Enum Type.

      Allowed values:
    • "BMS"
    • "ITCS"
  • object [BootNotificationConfirmationEnvelope]
  • object [BootNotificationResponse]

    Boot Notification Response.

  • BootNotificationStatusEnumType
    string

    Boot Notification Status Enum.

      Allowed values:
    • "Accepted"
    • "Rejected"
  • object [ProvideChargingRequestsRequestEnvelope]
  • object [AutomaticPreconditioning]

    Automatic Preconditioning.

  • ChargingInstruction
    string

    Charging Instruction Enum.

      Allowed values:
    • "Normal"
    • "Changed"
    • "Terminate"
  • object [ChargingRequest]

    Charging Request.

  • object [ChargingRequestData]

    Charging Request Data.

  • object [ManualPreconditioning]

    Manual Preconditioning.

  • PreconditioningRequest
    string

    Preconditioning Request Enum.

      Allowed values:
    • "WarmWaterAndVentilation"
    • "HotWaterAndHeating"
    • "NoWaterCoolingOrVentilation"
    • "NoClimaticPreconditioningOrSNA"
  • object [ProvideChargingRequestsRequest]

    Provide Charging Requests Request.

  • object [ProvideChargingRequestsConfirmationEnvelope]
  • object [ProvideChargingRequestsResponse]

    Provide Charging Requests Response.

  • object [ProvideChargingInformationRequestEnvelope]
  • ChargingPointFaultCode
    string

    Charging Point Fault Code Enum.

      Allowed values:
    • "NoFaultKnown"
    • "UsageFailure"
    • "CommunicationFailure"
    • "OtherChargingPointFailure"
  • object [ChargingPointFaultInfo]

    Charging Point Fault Info.

  • object [ChargingPointInfo]

    Charging Point Info.

  • ChargingPointStatus
    string

    Charging Point Status Enum.

      Allowed values:
    • "Available"
    • "Occupied"
    • "Reserved"
    • "Unavailable"
    • "Faulted"
  • 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.

  • ChargingStationFaultCode
    string

    Charging Station Fault Code Enum.

      Allowed values:
    • "NoFaultKnown"
    • "UsageFailure"
    • "CommunicationFailure"
    • "ElectricalOperationFailure"
    • "ConfigurationFailure"
    • "OtherChargingStationFailure"
  • object [ChargingStationFaultInfo]

    Charging Station Fault Info.

  • object [ChargingStationInfo]

    Charging Station Info.

  • ChargingStationStatus
    string

    Charging Station Status Enum.

      Allowed values:
    • "Available"
    • "Unavailable"
    • "Faulted"
  • object [DepotInfo]

    Depot Info.

  • object [ElectricData]

    Electric Data.

  • object [H2TankInfo]

    H2 Tank Info.

  • HealthStatus
    string

    Health Status Enum.

      Allowed values:
    • "OK"
    • "NOK"
    • "NA"
  • object [PreconditioningInfo]

    Preconditioning Info.

  • ProcessStatus
    string

    Process Status Enum.

      Allowed values:
    • "Preparing"
    • "Charging"
    • "SuspendedEVSE"
    • "SuspendedEV"
    • "Finishing"
    • "Queued"
    • "ChargingRejectedTechnically"
  • object [ProvideChargingInformationRequest]

    Provide Charging Information Request.

  • object [ScheduledChargingProcess]

    Scheduled Charging Process.

  • object [TractionBatteryInfo]

    Traction Battery Info.

  • VehicleChargingStatus
    string

    Vehicle Charging Status Enum.

      Allowed values:
    • "ReadyToCharge"
    • "Charging"
    • "ChargingImpossible"
    • "Unknown"
  • 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.

  • VdvErrorCode
    string

    VDV 463 Error Codes.

      Allowed values:
    • "InvalidRequest"
    • "UnknownAction"
    • "Unauthorized"
    • "NotSupported"
    • "InternalError"
    • "Timeout"
    • "ResourceUnavailable"
    • "RejectedTechnically"
    • "RejectedOperationally"
    • "InvalidState"
    • "Conflict"
  • VdvErrorMessage
    string

    VDV 463 Error Detail.

      Allowed values:
    • "The request message is malformed or missing mandatory fields."
    • "The specified MessageAction is not recognized or supported."
    • "Authentication or authorization has failed."
    • "The requested operation is not supported by this system."
    • "An internal system error or exception has occurred."
    • "Timeout - No response received from the downstream system within the expected timeframe."
    • "The required resource is unavailable, offline or not ready for the requested operation."
    • "The charging request has been rejected for technical reasons."
    • "The request cannot be fulfilled due to operational constraints."
    • "The requested action is not allowed in the current state."
    • "Another operation conflicts with the requested action."