@transreport/pauk-ujp-api
    Preparing search index...

    Type Alias JourneySearchRequest

    JourneySearchRequest: unknown & {
        destination: PlanningStationRef;
        include_calling_points?: boolean;
        include_cancelled?: boolean;
        include_considerations?: boolean;
        inward?: DirectionSearch;
        origin: PlanningStationRef;
        outward?: DirectionSearch;
        routing?: RoutingOptions;
    }

    Search outward, inward or both directions with one shared set of routing options. Inward reverses origin/destination; stations must differ. Omitted routing properties use defaults. For different routing options, send separate one-direction searches.

    Type Declaration

    • destination: PlanningStationRef
    • Optionalinclude_calling_points?: boolean

      Include available stops for each leg.

    • Optionalinclude_cancelled?: boolean

      Include journeys with any cancelled leg.

    • Optionalinclude_considerations?: boolean

      Assess current station facts for the stations each journey uses. Null when unrequested; [] when none. Clients can filter retained results by consideration kind.

    • Optionalinward?: DirectionSearch
    • origin: PlanningStationRef
    • Optionaloutward?: DirectionSearch
    • Optionalrouting?: RoutingOptions

    Settings
    Member Visibility