gis-tools-ts - v0.6.0
    Preparing search index...

    Class GTFSBookingRule

    Booking Rules

    Optional Defines rules for booking rider-requested services. Useful when a trip or stop_time requires advanced scheduling (e.g., dial-a-ride, on-demand pickup).

    Primary Key: (booking_rule_id)

    Index

    Constructors

    • Parameters

      • data: Record<string, string>

        the parsed GTFS CSV data

      Returns GTFSBookingRule

    Properties

    bookingType: GTFSBookingType

    Required Indicates how far in advance booking can be made. 0 = Real-time, 1 = Same-day, 2 = Prior-day(s)

    bookingUrl?: string

    Optional URL to an online interface or app to make a booking request.

    dropOffMessage?: string

    Optional Message for on-demand drop-off instructions.

    id: string

    Required Identifies a booking rule (booking_rule_id).

    infoUrl?: string

    Optional URL providing additional booking info.

    message?: string

    Optional Generic message to riders for on-demand booking instructions.

    phoneNumber?: string

    Optional Phone number riders call to make the booking request.

    pickupMessage?: string

    Optional Message for on-demand pickup instructions.

    priorNoticeDurationMax?: number

    Conditionally Forbidden Maximum number of minutes before travel to make the same-day request.

    • Forbidden for booking_type=0 or booking_type=2
    • Optional for booking_type=1
    priorNoticeDurationMin?: number

    Conditionally Required Minimum number of minutes before travel to make the request. Required for booking_type=1; forbidden otherwise.

    priorNoticeLastDay?: number

    Conditionally Required Last day before travel to make booking request. E.g., 1 = 1 day in advance. Required for booking_type=2; forbidden otherwise.

    priorNoticeLastTime?: string

    Conditionally Required Last time on the last day before travel to make booking request, e.g. "17:00:00". Required if prior_notice_last_day is defined; forbidden otherwise.

    priorNoticeServiceId?: string

    Conditionally Forbidden Service days on which last_day / start_day are counted (calendar.service_id).

    • Optional if booking_type=2.
    • Forbidden otherwise.
    priorNoticeStartDay?: number

    Conditionally Forbidden Earliest day before travel to make booking request.

    • Forbidden for booking_type=0.
    • Forbidden for booking_type=1 if prior_notice_duration_max is defined.
    • Optional otherwise (mainly for booking_type=2).
    priorNoticeStartTime?: string

    Conditionally Required Earliest time on the earliest day before travel, e.g. "00:00:00". Required if prior_notice_start_day is defined; forbidden otherwise.