Skip to content

SystemInfo-Request

Liefert Metadaten der EFA-Instanz: Version, Datenformat, Erstellungsdatum der Fahrplandaten und aktuelle Fahrplanabschnitte.

Endpoint

  • Pfad: XML_SYSTEMINFO_REQUEST
  • Methode: GET

Obligatorische Parameter

Keine. SystemInfo ist der einzige Request, der ohne Pflicht­parameter funktioniert.

Optionale Parameter

ParameterWerteBeschreibung
validityPeriod1Listet alle verfügbaren Fahrplanabschnitte auf

Siehe auch gemeinsame Parameter (outputFormat, hideBannerInfo, version).

Beispiel-Request

GET /XML_SYSTEMINFO_REQUEST?outputFormat=JSON&validityPeriod=1

Antwort (Beispiel)

Der EFA-JSON-Spec dokumentiert die konkreten Response-Felder nicht formal. Typischerweise enthalten sind:

json
{
  "version": "10.2.8.6",
  "ptKernel": { "appVersion": "...", "dataFormat": "..." },
  "dataFormat": "EFA10",
  "serverID": "efa-prod-01",
  "now": "2025-01-25T08:15:00Z",
  "validity": {
    "from": "2024-12-15",
    "to": "2025-06-14"
  }
}

Mit validityPeriod=1 wird validity zu einem Array aller bekannten Fahrplan­abschnitte.

JavaScript-Beispiele

js
async function getSystemInfo({ validityPeriod = false } = {}) {
  const base = 'https://server:port/virtuellesVerzeichnis/XML_SYSTEMINFO_REQUEST'
  const usp = new URLSearchParams({ outputFormat: 'JSON' })
  if (validityPeriod) usp.set('validityPeriod', '1')
  const res = await fetch(`${base}?${usp}`)
  if (!res.ok) throw new Error('HTTP ' + res.status)
  return res.json()
}

Hinweise

  • Nützlich als Health-Check beim Deployment — liefert ohne Parameter schnell eine Diagnose zu Erreichbarkeit und Datenstand.
  • Die validity-Angabe kann in PS-Request über psParamGroupID referenziert werden, um einen bestimmten Fahrplanabschnitt anzusprechen.