Skip to content

HTTP-Parameter-Makros

Manche EFA-Features erfordern nicht einen einzelnen Parameter, sondern ein ganzes Bündel. Damit Clients die Bundle-Logik nicht selbst pflegen müssen, bietet EFA Makros — ein einzelner URL-Parameter, der serverseitig zu einer vordefinierten Parametergruppe expandiert wird.

Prinzip

  1. Operator definiert das Makro in der EFAController-Konfiguration (Serverseite).
  2. Client setzt den Makro-Parameter in der URL (=1, =on, =true — wert­abhängig je Makro).
  3. Server ersetzt das Makro vor der Auswertung durch die konfigurierten Parameter.

Effekt: kürzere URLs, standortspezifische Defaults und einfachere API-Versionswechsel.

Standard-Makros

MakroWertWo genutztZweck
tripReductionMacro1TripPflicht-Bundle der Trip-Parameter
calcBicycleMacroonTripFahrradrouting aktivieren
brRoutingMacrotrueTripBike & Ride-Verbindungen
prRoutingMacrotrueTripPark & Ride-Verbindungen

Beispiel

GET /XML_TRIP_REQUEST2
    ?tripReductionMacro=1
    &calcBicycleMacro=on
    &brRoutingMacro=true
    &name_origin=de:05911:5494&type_origin=any
    &name_destination=de:05315:11000&type_destination=any

Welche konkreten Unterparameter das Makro expandiert, ist instanzabhängig — im Zweifel beim Betreiber erfragen oder calcBicycleMacro weglassen und die Einzelparameter manuell setzen.

Hinweise

  • Makros sind aktiviert, sobald gesetzt, unabhängig vom Wert (wertsemantik je Makro konfiguriert, aber die Anwesenheit zählt typischerweise).
  • Kollidierende Einzelparameter nach dem Makro können das Bundle partiell überschreiben — Reihenfolge der URL-Parameter ist jedoch nicht garantiert wirksam.
  • Eigene Makros können auf der Betreiberseite angelegt werden; dokumentieren Sie diese dann in Ihrer eigenen Instanz-Referenz.