ojp-sdk
    Preparing search index...

    Class OJPv1_FareRequest

    FareRequest (FR) class for OJP 1.0

    Instances are created via static methods below. Direct construction is intentionally disabled.

    • initWithOJPv1Trips - use Trip OJP 1.0 schema items

    Hierarchy

    Index

    Initialization

    initWithOJPv1Trips initWithRequestMock initWithResponseMock

    Constructors

    constructor

    Properties

    mockRequestXML mockResponseXML payload requestInfo

    Methods

    _fetchResponse buildRequestXML fetchResponse

    Initialization

    • Inits FR with OJP 1.0 Trip schema items

      Parameters

      • trips: {
            duration: string;
            endTime: string;
            startTime: string;
            transfers: number;
            tripId: string;
            tripLeg: {
                continuousLeg?: {
                    duration: string;
                    legEnd: {
                        geoPosition?: { latitude: number; longitude: number };
                        locationName: { text: string };
                        stopPlaceRef?: string;
                        stopPointRef?: string;
                    };
                    legStart: {
                        geoPosition?: { latitude: number; longitude: number };
                        locationName: { text: string };
                        stopPlaceRef?: string;
                        stopPointRef?: string;
                    };
                    legTrack?: {
                        trackSection: {
                            duration?: (...)
                            | (...);
                            length?: (...) | (...);
                            linkProjection?: (...) | (...);
                            roadName?: (...) | (...);
                            trackSectionEnd?: (...) | (...);
                            trackSectionStart?: (...) | (...);
                        }[];
                    };
                    length?: number;
                    pathGuidance?: {
                        pathGuidanceSection: {
                            guidanceAdvice?: (...)
                            | (...);
                            roadName?: (...) | (...);
                            trackSection?: (...) | (...);
                            turnAction?: (...) | (...);
                            turnDescription?: (...) | (...);
                        }[];
                    };
                    service: { individualMode: string };
                };
                duration?: string;
                legId: string;
                timedLeg?: {
                    extension?: {
                        operatorName?: { text: string };
                        publishedJourneyNumber?: { text: string };
                        transportTypeName?: { text: string };
                    };
                    legAlight: {
                        estimatedQuay?: { text: string };
                        expectedDepartureOccupancy?: {
                            fareClass: (...) | (...) | (...);
                            occupancyLevel: (...) | (...) | (...) | (...) | (...);
                        }[];
                        nameSuffix?: { text: string };
                        noAlightingAtStop?: boolean;
                        noBoardingAtStop?: boolean;
                        notServicedStop?: boolean;
                        order?: number;
                        plannedQuay?: { text: string };
                        requestStop?: boolean;
                        serviceArrival: { estimatedTime?: string; timetabledTime: string };
                        serviceDeparture?: { estimatedTime?: string; timetabledTime: string };
                        stopPointName: { text: string };
                        stopPointRef: string;
                        unplannedStop?: boolean;
                    };
                    legBoard: {
                        estimatedQuay?: { text: string };
                        expectedDepartureOccupancy?: {
                            fareClass: (...) | (...) | (...);
                            occupancyLevel: (...) | (...) | (...) | (...) | (...);
                        }[];
                        nameSuffix?: { text: string };
                        noAlightingAtStop?: boolean;
                        noBoardingAtStop?: boolean;
                        notServicedStop?: boolean;
                        order?: number;
                        plannedQuay?: { text: string };
                        requestStop?: boolean;
                        serviceArrival?: { estimatedTime?: string; timetabledTime: string };
                        serviceDeparture: { estimatedTime?: string; timetabledTime: string };
                        stopPointName: { text: string };
                        stopPointRef: string;
                        unplannedStop?: boolean;
                    };
                    legIntermediates: {
                        estimatedQuay?: { text: string };
                        expectedDepartureOccupancy?: { fareClass: ...; occupancyLevel: ... }[];
                        nameSuffix?: { text: string };
                        noAlightingAtStop?: boolean;
                        noBoardingAtStop?: boolean;
                        notServicedStop?: boolean;
                        order?: number;
                        plannedQuay?: { text: string };
                        requestStop?: boolean;
                        serviceArrival: { estimatedTime?: string; timetabledTime: string };
                        serviceDeparture: { estimatedTime?: string; timetabledTime: string };
                        stopPointName: { text: string };
                        stopPointRef: string;
                        unplannedStop?: boolean;
                    }[];
                    legTrack?: {
                        trackSection: {
                            duration?: (...)
                            | (...);
                            length?: (...) | (...);
                            linkProjection?: (...) | (...);
                            roadName?: (...) | (...);
                            trackEnd?: (...) | (...);
                            trackStart?: (...) | (...);
                        }[];
                    };
                    service: {
                        attribute: {
                            code: string;
                            hireFacility?: string;
                            importance?: number;
                            text: { text: string };
                        }[];
                        cancelled?: boolean;
                        conventionalModeOfOperation?: string;
                        destinationStopPointRef?: string;
                        destinationText?: { text: string };
                        deviation?: boolean;
                        directionRef?: string;
                        journeyRef: string;
                        lineRef: string;
                        mode: {
                            airSubmode?: string;
                            busSubmode?: string;
                            coachSubmode?: string;
                            funicularSubmode?: string;
                            metroSubmode?: string;
                            name?: { text: string };
                            ptMode:
                                | "other"
                                | "unknown"
                                | "air"
                                | "bus"
                                | "coach"
                                | "trolleyBus"
                                | "metro"
                                | "rail"
                                | "tram"
                                | "water"
                                | "ferry"
                                | "cableway"
                                | "funicular"
                                | "lift"
                                | "telecabin";
                            railSubmode?: | "international"
                            | "highSpeedRail"
                            | "interregionalRail"
                            | "railShuttle"
                            | "local"
                            | "vehicleTunnelTransportRailService";
                            shortName?: { text: string };
                            telecabinSubmode?: string;
                            tramSubmode?: string;
                            waterSubmode?: string;
                        };
                        operatingDayRef: string;
                        operatorRef?: string;
                        productCategory?: {
                            name?: { text: ... };
                            productCategoryRef?: string;
                            shortName?: { text: ... };
                        };
                        publicCode?: string;
                        publishedLineName: { text: string };
                        situationFullRef?: { participantRef: string; situationNumber: string }[];
                        trainNumber?: string;
                        unplanned?: boolean;
                    };
                };
                transferLeg?: {
                    duration: string;
                    legEnd: {
                        geoPosition?: { latitude: number; longitude: number };
                        locationName: { text: string };
                        stopPlaceRef?: string;
                        stopPointRef?: string;
                    };
                    legStart: {
                        geoPosition?: { latitude: number; longitude: number };
                        locationName: { text: string };
                        stopPlaceRef?: string;
                        stopPointRef?: string;
                    };
                    length?: number;
                    pathGuidance?: {
                        pathGuidanceSection: {
                            guidanceAdvice?: (...)
                            | (...);
                            roadName?: (...) | (...);
                            trackSection?: (...) | (...);
                            turnAction?: (...) | (...);
                            turnDescription?: (...) | (...);
                        }[];
                    };
                    transferType: "walk"
                    | "remainInVehicle"
                    | "changeWithinVehicle";
                };
            }[];
        }[]

        array of OJP_Types.OJPv1_TripSchema

        • duration: string
        • endTime: string

          Format: date-time

        • startTime: string

          Format: date-time

        • transfers: number
        • tripId: string
        • tripLeg: {
              continuousLeg?: {
                  duration: string;
                  legEnd: {
                      geoPosition?: { latitude: number; longitude: number };
                      locationName: { text: string };
                      stopPlaceRef?: string;
                      stopPointRef?: string;
                  };
                  legStart: {
                      geoPosition?: { latitude: number; longitude: number };
                      locationName: { text: string };
                      stopPlaceRef?: string;
                      stopPointRef?: string;
                  };
                  legTrack?: {
                      trackSection: {
                          duration?: (...)
                          | (...);
                          length?: (...) | (...);
                          linkProjection?: (...) | (...);
                          roadName?: (...) | (...);
                          trackSectionEnd?: (...) | (...);
                          trackSectionStart?: (...) | (...);
                      }[];
                  };
                  length?: number;
                  pathGuidance?: {
                      pathGuidanceSection: {
                          guidanceAdvice?: (...)
                          | (...);
                          roadName?: (...) | (...);
                          trackSection?: (...) | (...);
                          turnAction?: (...) | (...);
                          turnDescription?: (...) | (...);
                      }[];
                  };
                  service: { individualMode: string };
              };
              duration?: string;
              legId: string;
              timedLeg?: {
                  extension?: {
                      operatorName?: { text: string };
                      publishedJourneyNumber?: { text: string };
                      transportTypeName?: { text: string };
                  };
                  legAlight: {
                      estimatedQuay?: { text: string };
                      expectedDepartureOccupancy?: {
                          fareClass: (...) | (...) | (...);
                          occupancyLevel: (...) | (...) | (...) | (...) | (...);
                      }[];
                      nameSuffix?: { text: string };
                      noAlightingAtStop?: boolean;
                      noBoardingAtStop?: boolean;
                      notServicedStop?: boolean;
                      order?: number;
                      plannedQuay?: { text: string };
                      requestStop?: boolean;
                      serviceArrival: { estimatedTime?: string; timetabledTime: string };
                      serviceDeparture?: { estimatedTime?: string; timetabledTime: string };
                      stopPointName: { text: string };
                      stopPointRef: string;
                      unplannedStop?: boolean;
                  };
                  legBoard: {
                      estimatedQuay?: { text: string };
                      expectedDepartureOccupancy?: {
                          fareClass: (...) | (...) | (...);
                          occupancyLevel: (...) | (...) | (...) | (...) | (...);
                      }[];
                      nameSuffix?: { text: string };
                      noAlightingAtStop?: boolean;
                      noBoardingAtStop?: boolean;
                      notServicedStop?: boolean;
                      order?: number;
                      plannedQuay?: { text: string };
                      requestStop?: boolean;
                      serviceArrival?: { estimatedTime?: string; timetabledTime: string };
                      serviceDeparture: { estimatedTime?: string; timetabledTime: string };
                      stopPointName: { text: string };
                      stopPointRef: string;
                      unplannedStop?: boolean;
                  };
                  legIntermediates: {
                      estimatedQuay?: { text: string };
                      expectedDepartureOccupancy?: { fareClass: ...; occupancyLevel: ... }[];
                      nameSuffix?: { text: string };
                      noAlightingAtStop?: boolean;
                      noBoardingAtStop?: boolean;
                      notServicedStop?: boolean;
                      order?: number;
                      plannedQuay?: { text: string };
                      requestStop?: boolean;
                      serviceArrival: { estimatedTime?: string; timetabledTime: string };
                      serviceDeparture: { estimatedTime?: string; timetabledTime: string };
                      stopPointName: { text: string };
                      stopPointRef: string;
                      unplannedStop?: boolean;
                  }[];
                  legTrack?: {
                      trackSection: {
                          duration?: (...)
                          | (...);
                          length?: (...) | (...);
                          linkProjection?: (...) | (...);
                          roadName?: (...) | (...);
                          trackEnd?: (...) | (...);
                          trackStart?: (...) | (...);
                      }[];
                  };
                  service: {
                      attribute: {
                          code: string;
                          hireFacility?: string;
                          importance?: number;
                          text: { text: string };
                      }[];
                      cancelled?: boolean;
                      conventionalModeOfOperation?: string;
                      destinationStopPointRef?: string;
                      destinationText?: { text: string };
                      deviation?: boolean;
                      directionRef?: string;
                      journeyRef: string;
                      lineRef: string;
                      mode: {
                          airSubmode?: string;
                          busSubmode?: string;
                          coachSubmode?: string;
                          funicularSubmode?: string;
                          metroSubmode?: string;
                          name?: { text: string };
                          ptMode:
                              | "other"
                              | "unknown"
                              | "air"
                              | "bus"
                              | "coach"
                              | "trolleyBus"
                              | "metro"
                              | "rail"
                              | "tram"
                              | "water"
                              | "ferry"
                              | "cableway"
                              | "funicular"
                              | "lift"
                              | "telecabin";
                          railSubmode?: | "international"
                          | "highSpeedRail"
                          | "interregionalRail"
                          | "railShuttle"
                          | "local"
                          | "vehicleTunnelTransportRailService";
                          shortName?: { text: string };
                          telecabinSubmode?: string;
                          tramSubmode?: string;
                          waterSubmode?: string;
                      };
                      operatingDayRef: string;
                      operatorRef?: string;
                      productCategory?: {
                          name?: { text: ... };
                          productCategoryRef?: string;
                          shortName?: { text: ... };
                      };
                      publicCode?: string;
                      publishedLineName: { text: string };
                      situationFullRef?: { participantRef: string; situationNumber: string }[];
                      trainNumber?: string;
                      unplanned?: boolean;
                  };
              };
              transferLeg?: {
                  duration: string;
                  legEnd: {
                      geoPosition?: { latitude: number; longitude: number };
                      locationName: { text: string };
                      stopPlaceRef?: string;
                      stopPointRef?: string;
                  };
                  legStart: {
                      geoPosition?: { latitude: number; longitude: number };
                      locationName: { text: string };
                      stopPlaceRef?: string;
                      stopPointRef?: string;
                  };
                  length?: number;
                  pathGuidance?: {
                      pathGuidanceSection: {
                          guidanceAdvice?: (...)
                          | (...);
                          roadName?: (...) | (...);
                          trackSection?: (...) | (...);
                          turnAction?: (...) | (...);
                          turnDescription?: (...) | (...);
                      }[];
                  };
                  transferType: "walk"
                  | "remainInVehicle"
                  | "changeWithinVehicle";
              };
          }[]

      Returns OJPv1_FareRequest

    • Creates a new instance of the request class with a mock request XML string

      This method is used for testing purposes to simulate API requests with predefined XML payloads. When this mock is set, the request will use the provided XML instead of building a new one.

      Type Parameters

      • T_This extends { Default(): any }

      Parameters

      • this: T_This
      • mockText: string

        The XML string to use as the mock request

      Returns ReturnType<T_This["Default"]>

      A new instance of the request class with the mock set

      const mockRequest = LocationInformationRequest.initWithRequestMock('<OJP>...</OJP>');

    • Creates a new instance of the request class with a mock response XML string

      This method is used for testing purposes to simulate API responses with predefined XML payloads. When this mock is set, the request will use the provided XML response instead of making actual API calls.

      Type Parameters

      • T_This extends { Default(): any }

      Parameters

      • this: T_This
      • mockText: string

        The XML string to use as the mock response

      Returns ReturnType<T_This["Default"]>

      A new instance of the request class with the mock set

      const mockRequest = LocationInformationRequest.initWithResponseMock('<OJP>...</OJP>');

    Constructors

    • Parameters

      • items: {
            params?: {
                fareAuthorityFilter: string[];
                passengerCategory: (
                    | "Adult"
                    | "Child"
                    | "Senior"
                    | "Youth"
                    | "Disabled"
                    | "Dog"
                    | "Bicycle"
                    | "Motorcycle"
                    | "Car"
                    | "Truck"
                    | "Group"
                )[];
                travelClass?: string;
                traveller: {
                    age?: number;
                    entitlementProducts?: {
                        entitlementProduct: {
                            entitlementProductName: string;
                            entitlementProductRef: string;
                            fareAuthorityRef: string;
                        }[];
                    };
                    passengerCategory?: | "Adult"
                    | "Child"
                    | "Senior"
                    | "Youth"
                    | "Disabled"
                    | "Dog"
                    | "Bicycle"
                    | "Motorcycle"
                    | "Car"
                    | "Truck"
                    | "Group";
                }[];
            };
            requestTimestamp: string;
            tripFareRequest: {
                trip: {
                    duration: string;
                    endTime: string;
                    startTime: string;
                    transfers: number;
                    tripId: string;
                    tripLeg: {
                        continuousLeg?: {
                            duration: string;
                            legEnd: {
                                geoPosition?: { latitude: ...; longitude: ... };
                                locationName: { text: string };
                                stopPlaceRef?: string;
                                stopPointRef?: string;
                            };
                            legStart: {
                                geoPosition?: { latitude: ...; longitude: ... };
                                locationName: { text: string };
                                stopPlaceRef?: string;
                                stopPointRef?: string;
                            };
                            legTrack?: { trackSection: (...)[] };
                            length?: number;
                            pathGuidance?: { pathGuidanceSection: (...)[] };
                            service: { individualMode: string };
                        };
                        duration?: string;
                        legId: string;
                        timedLeg?: {
                            extension?: {
                                operatorName?: (...)
                                | (...);
                                publishedJourneyNumber?: (...) | (...);
                                transportTypeName?: (...) | (...);
                            };
                            legAlight: {
                                estimatedQuay?: { text: ... };
                                expectedDepartureOccupancy?: (...)[];
                                nameSuffix?: { text: ... };
                                noAlightingAtStop?: boolean;
                                noBoardingAtStop?: boolean;
                                notServicedStop?: boolean;
                                order?: number;
                                plannedQuay?: { text: ... };
                                requestStop?: boolean;
                                serviceArrival: {
                                    estimatedTime?: (...) | (...);
                                    timetabledTime: string;
                                };
                                serviceDeparture?: { estimatedTime?: ...; timetabledTime: ... };
                                stopPointName: { text: string };
                                stopPointRef: string;
                                unplannedStop?: boolean;
                            };
                            legBoard: {
                                estimatedQuay?: { text: ... };
                                expectedDepartureOccupancy?: (...)[];
                                nameSuffix?: { text: ... };
                                noAlightingAtStop?: boolean;
                                noBoardingAtStop?: boolean;
                                notServicedStop?: boolean;
                                order?: number;
                                plannedQuay?: { text: ... };
                                requestStop?: boolean;
                                serviceArrival?: { estimatedTime?: ...; timetabledTime: ... };
                                serviceDeparture: {
                                    estimatedTime?: (...) | (...);
                                    timetabledTime: string;
                                };
                                stopPointName: { text: string };
                                stopPointRef: string;
                                unplannedStop?: boolean;
                            };
                            legIntermediates: {
                                estimatedQuay?: (...)
                                | (...);
                                expectedDepartureOccupancy?: (...) | (...);
                                nameSuffix?: (...) | (...);
                                noAlightingAtStop?: (...) | (...) | (...);
                                noBoardingAtStop?: (...) | (...) | (...);
                                notServicedStop?: (...) | (...) | (...);
                                order?: (...) | (...);
                                plannedQuay?: (...) | (...);
                                requestStop?: (...) | (...) | (...);
                                serviceArrival: { estimatedTime?: ...; timetabledTime: ... };
                                serviceDeparture: { estimatedTime?: ...; timetabledTime: ... };
                                stopPointName: { text: ... };
                                stopPointRef: string;
                                unplannedStop?: (...) | (...) | (...);
                            }[];
                            legTrack?: { trackSection: (...)[] };
                            service: {
                                attribute: {
                                    code: ...;
                                    hireFacility?: ...;
                                    importance?: ...;
                                    text: ...;
                                }[];
                                cancelled?: boolean;
                                conventionalModeOfOperation?: string;
                                destinationStopPointRef?: string;
                                destinationText?: { text: ... };
                                deviation?: boolean;
                                directionRef?: string;
                                journeyRef: string;
                                lineRef: string;
                                mode: {
                                    airSubmode?: (...) | (...);
                                    busSubmode?: (...) | (...);
                                    coachSubmode?: (...) | (...);
                                    funicularSubmode?: (...) | (...);
                                    metroSubmode?: (...) | (...);
                                    name?: (...) | (...);
                                    ptMode:
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...)
                                        | (...);
                                    railSubmode?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                    shortName?: (...) | (...);
                                    telecabinSubmode?: (...) | (...);
                                    tramSubmode?: (...) | (...);
                                    waterSubmode?: (...) | (...);
                                };
                                operatingDayRef: string;
                                operatorRef?: string;
                                productCategory?: {
                                    name?: ...;
                                    productCategoryRef?: ...;
                                    shortName?: ...;
                                };
                                publicCode?: string;
                                publishedLineName: { text: string };
                                situationFullRef?: (...)[];
                                trainNumber?: string;
                                unplanned?: boolean;
                            };
                        };
                        transferLeg?: {
                            duration: string;
                            legEnd: {
                                geoPosition?: { latitude: ...; longitude: ... };
                                locationName: { text: string };
                                stopPlaceRef?: string;
                                stopPointRef?: string;
                            };
                            legStart: {
                                geoPosition?: { latitude: ...; longitude: ... };
                                locationName: { text: string };
                                stopPlaceRef?: string;
                                stopPointRef?: string;
                            };
                            length?: number;
                            pathGuidance?: { pathGuidanceSection: (...)[] };
                            transferType: "walk" | "remainInVehicle" | "changeWithinVehicle";
                        };
                    }[];
                };
            };
        }[]

      Returns OJPv1_FareRequest

    Properties

    mockRequestXML: string | null
    mockResponseXML: string | null
    payload: {
        params?: {
            fareAuthorityFilter: string[];
            passengerCategory: (
                | "Adult"
                | "Child"
                | "Senior"
                | "Youth"
                | "Disabled"
                | "Dog"
                | "Bicycle"
                | "Motorcycle"
                | "Car"
                | "Truck"
                | "Group"
            )[];
            travelClass?: string;
            traveller: {
                age?: number;
                entitlementProducts?: {
                    entitlementProduct: {
                        entitlementProductName: string;
                        entitlementProductRef: string;
                        fareAuthorityRef: string;
                    }[];
                };
                passengerCategory?: | "Adult"
                | "Child"
                | "Senior"
                | "Youth"
                | "Disabled"
                | "Dog"
                | "Bicycle"
                | "Motorcycle"
                | "Car"
                | "Truck"
                | "Group";
            }[];
        };
        requestTimestamp: string;
        tripFareRequest: {
            trip: {
                duration: string;
                endTime: string;
                startTime: string;
                transfers: number;
                tripId: string;
                tripLeg: {
                    continuousLeg?: {
                        duration: string;
                        legEnd: {
                            geoPosition?: { latitude: ...; longitude: ... };
                            locationName: { text: string };
                            stopPlaceRef?: string;
                            stopPointRef?: string;
                        };
                        legStart: {
                            geoPosition?: { latitude: ...; longitude: ... };
                            locationName: { text: string };
                            stopPlaceRef?: string;
                            stopPointRef?: string;
                        };
                        legTrack?: { trackSection: (...)[] };
                        length?: number;
                        pathGuidance?: { pathGuidanceSection: (...)[] };
                        service: { individualMode: string };
                    };
                    duration?: string;
                    legId: string;
                    timedLeg?: {
                        extension?: {
                            operatorName?: (...)
                            | (...);
                            publishedJourneyNumber?: (...) | (...);
                            transportTypeName?: (...) | (...);
                        };
                        legAlight: {
                            estimatedQuay?: { text: ... };
                            expectedDepartureOccupancy?: (...)[];
                            nameSuffix?: { text: ... };
                            noAlightingAtStop?: boolean;
                            noBoardingAtStop?: boolean;
                            notServicedStop?: boolean;
                            order?: number;
                            plannedQuay?: { text: ... };
                            requestStop?: boolean;
                            serviceArrival: {
                                estimatedTime?: (...) | (...);
                                timetabledTime: string;
                            };
                            serviceDeparture?: { estimatedTime?: ...; timetabledTime: ... };
                            stopPointName: { text: string };
                            stopPointRef: string;
                            unplannedStop?: boolean;
                        };
                        legBoard: {
                            estimatedQuay?: { text: ... };
                            expectedDepartureOccupancy?: (...)[];
                            nameSuffix?: { text: ... };
                            noAlightingAtStop?: boolean;
                            noBoardingAtStop?: boolean;
                            notServicedStop?: boolean;
                            order?: number;
                            plannedQuay?: { text: ... };
                            requestStop?: boolean;
                            serviceArrival?: { estimatedTime?: ...; timetabledTime: ... };
                            serviceDeparture: {
                                estimatedTime?: (...) | (...);
                                timetabledTime: string;
                            };
                            stopPointName: { text: string };
                            stopPointRef: string;
                            unplannedStop?: boolean;
                        };
                        legIntermediates: {
                            estimatedQuay?: (...)
                            | (...);
                            expectedDepartureOccupancy?: (...) | (...);
                            nameSuffix?: (...) | (...);
                            noAlightingAtStop?: (...) | (...) | (...);
                            noBoardingAtStop?: (...) | (...) | (...);
                            notServicedStop?: (...) | (...) | (...);
                            order?: (...) | (...);
                            plannedQuay?: (...) | (...);
                            requestStop?: (...) | (...) | (...);
                            serviceArrival: { estimatedTime?: ...; timetabledTime: ... };
                            serviceDeparture: { estimatedTime?: ...; timetabledTime: ... };
                            stopPointName: { text: ... };
                            stopPointRef: string;
                            unplannedStop?: (...) | (...) | (...);
                        }[];
                        legTrack?: { trackSection: (...)[] };
                        service: {
                            attribute: {
                                code: ...;
                                hireFacility?: ...;
                                importance?: ...;
                                text: ...;
                            }[];
                            cancelled?: boolean;
                            conventionalModeOfOperation?: string;
                            destinationStopPointRef?: string;
                            destinationText?: { text: ... };
                            deviation?: boolean;
                            directionRef?: string;
                            journeyRef: string;
                            lineRef: string;
                            mode: {
                                airSubmode?: (...) | (...);
                                busSubmode?: (...) | (...);
                                coachSubmode?: (...) | (...);
                                funicularSubmode?: (...) | (...);
                                metroSubmode?: (...) | (...);
                                name?: (...) | (...);
                                ptMode:
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...)
                                    | (...);
                                railSubmode?: (...) | (...) | (...) | (...) | (...) | (...) | (...);
                                shortName?: (...) | (...);
                                telecabinSubmode?: (...) | (...);
                                tramSubmode?: (...) | (...);
                                waterSubmode?: (...) | (...);
                            };
                            operatingDayRef: string;
                            operatorRef?: string;
                            productCategory?: {
                                name?: ...;
                                productCategoryRef?: ...;
                                shortName?: ...;
                            };
                            publicCode?: string;
                            publishedLineName: { text: string };
                            situationFullRef?: (...)[];
                            trainNumber?: string;
                            unplanned?: boolean;
                        };
                    };
                    transferLeg?: {
                        duration: string;
                        legEnd: {
                            geoPosition?: { latitude: ...; longitude: ... };
                            locationName: { text: string };
                            stopPlaceRef?: string;
                            stopPointRef?: string;
                        };
                        legStart: {
                            geoPosition?: { latitude: ...; longitude: ... };
                            locationName: { text: string };
                            stopPlaceRef?: string;
                            stopPointRef?: string;
                        };
                        length?: number;
                        pathGuidance?: { pathGuidanceSection: (...)[] };
                        transferType: "walk" | "remainInVehicle" | "changeWithinVehicle";
                    };
                }[];
            };
        };
    }[]

    The payload object that gets serialized to XML for the request (OJP v1)

    requestInfo: RequestInfo

    Methods

    Protected_fetchResponse

    • Builds the XML request string for the FR

      Parameters

      • language: Language

        The language to use for the request (e.g. "en", "de")

      • requestorRef: string

        The requestor reference identifier

      • xmlConfig: XML_Config

        XML configuration options for building the request, default XML_BuilderConfigOJPv1 OJP 1.0

      Returns string

      A formatted XML string representing the Location Information Request

    Settings

    Member Visibility

    On This Page

    Initialization
    Constructors
    Properties
    Methods