Skip to content

API

Implemented Surface

Surface Type Status Current behaviour
/vdv463/ws WebSocket Upgrade Accepts JSON messages matching MessageStructure and returns confirmation or error envelopes.
/vdv463/docs/asyncapi GET 200 Returns the generated AsyncAPI 3.0.0 document for the VDV 463 CMS endpoint.

WebSocket Message Handling

Inbound messageAction Expected messageType Current behaviour
BootNotification Request Validates BootNotificationRequest and returns a confirmation with status = Accepted.
ProvideChargingRequests Request Validates ProvideChargingRequestsRequest and returns an empty confirmation payload.
ProvideChargingInformation Confirmation Modelled in the docs as the acknowledgement to CMS-originated updates, but not completed in the runtime handler. Invalid or incomplete usage currently falls through to the error path.
Unsupported or malformed action/payload Any Returns an error envelope with messageType = Error.

Envelope Format

  • The current FastAPI WebSocket handler validates named JSON objects with these fields: messageType, source, presystemId, timeStamp, messageId, messageAction, and payload.
  • The repo also includes helper methods to convert to or from the seven-slot array shorthand used in some scenario examples, but the live WebSocket route expects the named-field object form.
  • Reference artifacts: ./schema/asyncapi.yaml, VDV_463_7_AsyncAPI_Specification.md, and /vdv463/docs/asyncapi.

Standard Expectations Not Enforced By The Route

  • TLS-secured wss:// deployment.
  • HTTP Basic Authentication during the handshake.
  • WebSocket subprotocol negotiation with v1.463.vdv.de.
  • Correlation of CMS-originated ProvideChargingInformation updates with received confirmations.