EFA JSON-Schnittstelle

Appearance

Changelog ​

v3.0 — 2026-04-18 ​

Komplette Überarbeitung gegen die Mentz-PDF „EFA JSON-Schnittstelle V2.0 / 18.06.2021".

Breaking ​

  • Parameter­namen angeglichen: Alle generischen Platzhalter­namen (stopId, limit, rt, coord=lat,lon) sind durch die realen EFA-Parameter ersetzt (name_<usage>/type_<usage>, useRealtime, coord=x:y:WGS84[dd.ddddd]). Clients, die nach den alten Beispielen gebaut sind, müssen auf das reale Schema migrieren.
  • URL-Pfade korrigiert:
    • XML_COORDINFO_REQUEST → XML_COORD_REQUEST
    • XML_TRIP_REQUEST → XML_TRIP_REQUEST2
    • XML_PS_REQUEST → XML_PS_REQUEST2
    • XML_STOPTIMETABLE_REQUEST → XML_STT_REQUEST
  • outputFormat=JSON ist als Pflicht­parameter für JSON-Antworten dokumentiert und in allen Beispielen gesetzt.

Neu ​

  • reference/common-parameters.md — request-unabhängige Parameter (hideBannerInfo, version, outputFormat) und Pointer auf die Querschnitts­seiten.
  • concepts/point-input.md — name_<usage> / type_<usage> mit allen Usage-Varianten und Koordinaten-Syntax.
  • concepts/line-input.md — line=<Netz>:<Nummer>:<Ergänzung>:<Richtung>, Mehrfachangabe, lineReqType-Bitmaske.
  • concepts/date-time.md — vollständige itdDate* / itdTime*-Familie aus dem PDF, timeOffset.
  • concepts/mot-ids.md — Appendix der Verkehrsmittel-IDs (0–19) und Nutzung in exclMOT_*, inclMOT_*, filterMOTType, prefStModeAm.
  • concepts/object-types.md — Objekttyp-Bitmasken (StopFinder) und Enum-Werte (CoordInfo) in einer Übersicht.
  • concepts/macros.md — HTTP-Parameter-Makros (tripReductionMacro, calcBicycleMacro, brRoutingMacro, prRoutingMacro).
  • guide/getting-started.md — End-to-End-Sequenz StopFinder → DM als Copy-paste-Code.
  • guide/error-handling.md — erweitert um das reale systemMessages[]-Payload-Schema (code, error, type, module).

Geändert ​

  • Alle 17 Endpoint-Seiten neu strukturiert: konsistentes H2-Gerüst (Endpoint · Obligatorische Parameter · Optionale Parameter · Beispiel-Request · Antwort (Beispiel) · JavaScript-Beispiele · Hinweise).
  • Parameter nur noch PDF-belegt; Querschnitts­parameter werden einmal in /concepts/ definiert und aus den Endpoints verlinkt.
  • Beispiel-Requests nutzen durchgängig echte Parametermuster (z. B. type_dm=any&name_dm=de:…).
  • Sidebar in funktionale Cluster gruppiert (Suche & Entdeckung, Fahrtauskunft, Monitore, Geometrie & Karte, Infrastruktur & Sharing, Meldungen & System).

Behoben ​

  • Duplikat-Frontmatter in stoplist.md, stopseqcoord.md, stoptimetable.md, tripstoptimes.md entfernt.
  • Inkonsistente Code-Block-Labels vereinheitlicht ([Browser], [Node], [TypeScript], …).
  • parkobject.md war prosa-lastig und ohne Parameter­tabelle — jetzt mit strukturierter Tabelle und XOR-Hinweis für paID / paIDStop.
  • systeminfo.md war extrem dünn — jetzt mit validityPeriod-Parameter und Antwort-Skizze.

Nicht enthalten (Follow-ups) ​

  • Formale JSON-Schemas / OpenAPI — die PDF dokumentiert Responses nicht strukturiert.
  • Interaktives Try-it-out.
  • Englische Übersetzung.
  • Fehlercode-Referenz (EFA9-10_Errorcodes) — wird separat von Mentz gepflegt, wir verlinken nur darauf.

v2.0 — 2026-04-18 ​

Initiale VitePress-Doku-Aufsetzung aus der Mentz-PDF heraus — Endpoint-Übersicht, Home-Page mit Feature-Grid. Parameternamen wurden damals generisch gehalten (stopId, limit, coord=lat,lon); siehe v3.0 für die Angleichung an das reale EFA-Schema.