Class LocationInformationRequest

LocationInformationRequest (LIR) class

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

initWithLocationName - use location name, i.e. Bern
initWithPlaceRef - use place ref or literal coordinates (lat, lng)
initWithBBOX - use bounding box to filter locations

Hierarchy

SharedLocationInformationRequest<
{ fetchResponse: LocationInformationRequestResponse },
>
- LocationInformationRequest

Index

Initialization

`Static`initWithBBOX

initWithBBOX(
    bboxData: string | number[],
    placeTypes?: ("location" | "stop" | "address" | "poi" | "topographicPlace")[],
    numberOfResults?: number,
): LocationInformationRequest
Inits LIR with bounding box
Parameters
- bboxData: string | number[]
  bounding box data as string ("minLon,minLat,maxLon,maxLat") or array [minLon, minLat, maxLon, maxLat]
- placeTypes: ("location" | "stop" | "address" | "poi" | "topographicPlace")[] = []
  OJP_Types.PlaceTypeEnum "stop" | "address" | "poi" | "location" | "topographicPlace"
- numberOfResults: number = 10
  maximum number of results to return (default: 10)
Returns LocationInformationRequest
- Defined in src/versions/current/requests/lir.ts:108

`Static`initWithLocationName

initWithLocationName(
    name: string,
    placeTypes?: ("location" | "stop" | "address" | "poi" | "topographicPlace")[],
    numberOfResults?: number,
): LocationInformationRequest
Inits LIR with location name
Parameters
- name: string
  string, location name
- placeTypes: ("location" | "stop" | "address" | "poi" | "topographicPlace")[] = []
  OJP_Types.PlaceTypeEnum "stop" | "address" | "poi" | "location" | "topographicPlace"
- numberOfResults: number = 10
  maximum number of results to return (default: 10)
Returns LocationInformationRequest
- Defined in src/versions/current/requests/lir.ts:66

`Static`initWithPlaceRef

initWithPlaceRef(
placeRefOrCoords: string,
numberOfResults?: number,
): LocationInformationRequest
Inits LIR with place ref or literal coords
Parameters
- placeRefOrCoords: string
  place reference or coordinates string (e.g. ch:1:sloid:7000:4:7 or 46.94857,7.43683 (latitude, longitude in WGS84))
- numberOfResults: number = 10
  maximum number of results to return (default: 10)
Returns LocationInformationRequest
- Defined in src/versions/current/requests/lir.ts:87

`Static`initWithRequestMock

initWithRequestMock<T_This extends { Default(): any }>(
this: T_This,
mockText: string,
): ReturnType<T_This["Default"]>
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
Example
```
const mockRequest = LocationInformationRequest.initWithRequestMock('<OJP>...</OJP>');
```
Inherited from SharedLocationInformationRequest.initWithRequestMock
- Defined in src/versions/current/requests/base.ts:42

`Static`initWithResponseMock

initWithResponseMock<T_This extends { Default(): any }>(
this: T_This,
mockText: string,
): ReturnType<T_This["Default"]>
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
Example
```
const mockRequest = LocationInformationRequest.initWithResponseMock('<OJP>...</OJP>');
```
Inherited from SharedLocationInformationRequest.initWithResponseMock
- Defined in src/versions/current/requests/base.ts:64

Constructors

`Protected`constructor

new LocationInformationRequest(
    restrictions:
        | {
            includePtModes?: boolean;
            modes?: {
                airSubmode?: string;
                busSubmode?: string;
                coachSubmode?: string;
                exclude?: boolean;
                funicularSubmode?: string;
                metroSubmode?: string;
                personalMode: (
                    | "other"
                    | "foot"
                    | "bicycle"
                    | "car"
                    | "motorcycle"
                    | "truck"
                    | "scooter"
                )[];
                ptMode: (
                    | "other"
                    | "unknown"
                    | "air"
                    | "bus"
                    | "coach"
                    | "trolleyBus"
                    | "metro"
                    | "rail"
                    | "tram"
                    | "water"
                    | "ferry"
                    | "cableway"
                    | "funicular"
                    | "lift"
                    | "telecabin"
                )[];
                railSubmode?: | "international"
                | "highSpeedRail"
                | "interregionalRail"
                | "railShuttle"
                | "local"
                | "vehicleTunnelTransportRailService";
                telecabinSubmode?: string;
                tramSubmode?: string;
                waterSubmode?: string;
            };
            numberOfResults?: number;
            pointOfInterestFilter?: {
                exclude?: boolean;
                pointOfInterestCategory: {
                    osmTag: { tag: string; value: string }[];
                    pointOfInterestClassification: string[];
                }[];
            };
            type: ("location" | "stop" | "address" | "poi" | "topographicPlace")[];
        }
        | undefined,
): LocationInformationRequest
Parameters
- restrictions:
      | {
          includePtModes?: boolean;
          modes?: {
              airSubmode?: string;
              busSubmode?: string;
              coachSubmode?: string;
              exclude?: boolean;
              funicularSubmode?: string;
              metroSubmode?: string;
              personalMode: (
                  | "other"
                  | "foot"
                  | "bicycle"
                  | "car"
                  | "motorcycle"
                  | "truck"
                  | "scooter"
              )[];
              ptMode: (
                  | "other"
                  | "unknown"
                  | "air"
                  | "bus"
                  | "coach"
                  | "trolleyBus"
                  | "metro"
                  | "rail"
                  | "tram"
                  | "water"
                  | "ferry"
                  | "cableway"
                  | "funicular"
                  | "lift"
                  | "telecabin"
              )[];
              railSubmode?: | "international"
              | "highSpeedRail"
              | "interregionalRail"
              | "railShuttle"
              | "local"
              | "vehicleTunnelTransportRailService";
              telecabinSubmode?: string;
              tramSubmode?: string;
              waterSubmode?: string;
          };
          numberOfResults?: number;
          pointOfInterestFilter?: {
              exclude?: boolean;
              pointOfInterestCategory: {
                  osmTag: { tag: string; value: string }[];
                  pointOfInterestClassification: string[];
              }[];
          };
          type: ("location" | "stop" | "address" | "poi" | "topographicPlace")[];
      }
      | undefined
Returns LocationInformationRequest
Overrides SharedLocationInformationRequest<{ fetchResponse: LocationInformationRequestResponse }>.constructor
- Defined in src/versions/current/requests/lir.ts:35

Properties

mockRequestXML

mockRequestXML: string | null

mockResponseXML

mockResponseXML: string | null

payload

payload: {
    initialInput?: {
        geoRestriction?: {
            rectangle: {
                lowerRight: { latitude: number; longitude: number };
                upperLeft: { latitude: number; longitude: number };
            };
        };
        name?: string;
    };
    placeRef?: {
        geoPosition?: { latitude: number; longitude: number };
        name: { text: string };
        stopPlaceRef?: string;
        stopPointRef?: string;
    };
    requestTimestamp: string;
    restrictions?: {
        includePtModes?: boolean;
        modes?: {
            airSubmode?: string;
            busSubmode?: string;
            coachSubmode?: string;
            exclude?: boolean;
            funicularSubmode?: string;
            metroSubmode?: string;
            personalMode: (
                | "other"
                | "foot"
                | "bicycle"
                | "car"
                | "motorcycle"
                | "truck"
                | "scooter"
            )[];
            ptMode: (
                | "other"
                | "unknown"
                | "air"
                | "bus"
                | "coach"
                | "trolleyBus"
                | "metro"
                | "rail"
                | "tram"
                | "water"
                | "ferry"
                | "cableway"
                | "funicular"
                | "lift"
                | "telecabin"
            )[];
            railSubmode?: | "international"
            | "highSpeedRail"
            | "interregionalRail"
            | "railShuttle"
            | "local"
            | "vehicleTunnelTransportRailService";
            telecabinSubmode?: string;
            tramSubmode?: string;
            waterSubmode?: string;
        };
        numberOfResults?: number;
        pointOfInterestFilter?: {
            exclude?: boolean;
            pointOfInterestCategory: {
                osmTag: { tag: string; value: string }[];
                pointOfInterestClassification: string[];
            }[];
        };
        type: ("location" | "stop" | "address" | "poi" | "topographicPlace")[];
    };
}

The payload object that gets serialized to XML for the request

See

OJP LocationInformationRequest XSD Schema

requestInfo

requestInfo: RequestInfo

Methods

`Protected`_fetchResponse

_fetchResponse(sdk: SDK<"2.0">): Promise<LocationInformationRequestResponse>
Parameters
- sdk: SDK<"2.0">
Returns Promise<LocationInformationRequestResponse>
Overrides SharedLocationInformationRequest._fetchResponse
- Defined in src/versions/current/requests/lir.ts:155

buildRequestXML

buildRequestXML(
    language: Language,
    requestorRef: string,
    xmlConfig?: XML_Config,
): string
Builds the XML request string for the LIR
Parameters
- language: Language
  The language to use for the request (e.g. "en", "de")
- requestorRef: string
  The requestor reference identifier
- xmlConfig: XML_Config = DefaultXML_Config
  XML configuration options for building the request, default DefaultXML_Config OJP 2.0
Returns string
A formatted XML string representing the Location Information Request
Overrides SharedLocationInformationRequest.buildRequestXML
- Defined in src/versions/current/requests/lir.ts:134

fetchResponse

fetchResponse(sdk: AnySDK): Promise<LocationInformationRequestResponse>
Parameters
- sdk: AnySDK
Returns Promise<LocationInformationRequestResponse>
Inherited from SharedLocationInformationRequest.fetchResponse
- Defined in src/versions/current/requests/base.ts:71

`Protected`updateRestrictions

updateRestrictions(
    restrictions: {
        includePtModes?: boolean;
        modes?: {
            airSubmode?: string;
            busSubmode?: string;
            coachSubmode?: string;
            exclude?: boolean;
            funicularSubmode?: string;
            metroSubmode?: string;
            personalMode: (
                | "other"
                | "foot"
                | "bicycle"
                | "car"
                | "motorcycle"
                | "truck"
                | "scooter"
            )[];
            ptMode: (
                | "other"
                | "unknown"
                | "air"
                | "bus"
                | "coach"
                | "trolleyBus"
                | "metro"
                | "rail"
                | "tram"
                | "water"
                | "ferry"
                | "cableway"
                | "funicular"
                | "lift"
                | "telecabin"
            )[];
            railSubmode?: | "international"
            | "highSpeedRail"
            | "interregionalRail"
            | "railShuttle"
            | "local"
            | "vehicleTunnelTransportRailService";
            telecabinSubmode?: string;
            tramSubmode?: string;
            waterSubmode?: string;
        };
        numberOfResults?: number;
        pointOfInterestFilter?: {
            exclude?: boolean;
            pointOfInterestCategory: {
                osmTag: { tag: string; value: string }[];
                pointOfInterestClassification: string[];
            }[];
        };
        type: ("location" | "stop" | "address" | "poi" | "topographicPlace")[];
    },
    placeTypes: ("location" | "stop" | "address" | "poi" | "topographicPlace")[],
    numberOfResults: number,
): void
Parameters
- restrictions: {
      includePtModes?: boolean;
      modes?: {
          airSubmode?: string;
          busSubmode?: string;
          coachSubmode?: string;
          exclude?: boolean;
          funicularSubmode?: string;
          metroSubmode?: string;
          personalMode: (
              | "other"
              | "foot"
              | "bicycle"
              | "car"
              | "motorcycle"
              | "truck"
              | "scooter"
          )[];
          ptMode: (
              | "other"
              | "unknown"
              | "air"
              | "bus"
              | "coach"
              | "trolleyBus"
              | "metro"
              | "rail"
              | "tram"
              | "water"
              | "ferry"
              | "cableway"
              | "funicular"
              | "lift"
              | "telecabin"
          )[];
          railSubmode?: | "international"
          | "highSpeedRail"
          | "interregionalRail"
          | "railShuttle"
          | "local"
          | "vehicleTunnelTransportRailService";
          telecabinSubmode?: string;
          tramSubmode?: string;
          waterSubmode?: string;
      };
      numberOfResults?: number;
      pointOfInterestFilter?: {
          exclude?: boolean;
          pointOfInterestCategory: {
              osmTag: { tag: string; value: string }[];
              pointOfInterestClassification: string[];
          }[];
      };
      type: ("location" | "stop" | "address" | "poi" | "topographicPlace")[];
  }
- placeTypes: ("location" | "stop" | "address" | "poi" | "topographicPlace")[]
- numberOfResults: number
Returns void
Inherited from SharedLocationInformationRequest.updateRestrictions
- Defined in src/versions/current/requests/lir.shared.ts:17

`Protected` `Static`computeGeoRestriction

computeGeoRestriction(
    bboxData: string | number[],
):
    | {
        rectangle: {
            lowerRight: { latitude: number; longitude: number };
            upperLeft: { latitude: number; longitude: number };
        };
    }
    | null
Parameters
- bboxData: string | number[]
Returns
    | {
        rectangle: {
            lowerRight: { latitude: number; longitude: number };
            upperLeft: { latitude: number; longitude: number };
        };
    }
    | null
Inherited from SharedLocationInformationRequest.computeGeoRestriction
- Defined in src/versions/current/requests/lir.shared.ts:27

`Protected` `Static`DefaultRestrictionParams

DefaultRestrictionParams(): {
    includePtModes?: boolean;
    modes?: {
        airSubmode?: string;
        busSubmode?: string;
        coachSubmode?: string;
        exclude?: boolean;
        funicularSubmode?: string;
        metroSubmode?: string;
        personalMode: (
            | "other"
            | "foot"
            | "bicycle"
            | "car"
            | "motorcycle"
            | "truck"
            | "scooter"
        )[];
        ptMode: (
            | "other"
            | "unknown"
            | "air"
            | "bus"
            | "coach"
            | "trolleyBus"
            | "metro"
            | "rail"
            | "tram"
            | "water"
            | "ferry"
            | "cableway"
            | "funicular"
            | "lift"
            | "telecabin"
        )[];
        railSubmode?: | "international"
        | "highSpeedRail"
        | "interregionalRail"
        | "railShuttle"
        | "local"
        | "vehicleTunnelTransportRailService";
        telecabinSubmode?: string;
        tramSubmode?: string;
        waterSubmode?: string;
    };
    numberOfResults?: number;
    pointOfInterestFilter?: {
        exclude?: boolean;
        pointOfInterestCategory: {
            osmTag: { tag: string; value: string }[];
            pointOfInterestClassification: string[];
        }[];
    };
    type: ("location" | "stop" | "address" | "poi" | "topographicPlace")[];
}
Returns {
    includePtModes?: boolean;
    modes?: {
        airSubmode?: string;
        busSubmode?: string;
        coachSubmode?: string;
        exclude?: boolean;
        funicularSubmode?: string;
        metroSubmode?: string;
        personalMode: (
            | "other"
            | "foot"
            | "bicycle"
            | "car"
            | "motorcycle"
            | "truck"
            | "scooter"
        )[];
        ptMode: (
            | "other"
            | "unknown"
            | "air"
            | "bus"
            | "coach"
            | "trolleyBus"
            | "metro"
            | "rail"
            | "tram"
            | "water"
            | "ferry"
            | "cableway"
            | "funicular"
            | "lift"
            | "telecabin"
        )[];
        railSubmode?: | "international"
        | "highSpeedRail"
        | "interregionalRail"
        | "railShuttle"
        | "local"
        | "vehicleTunnelTransportRailService";
        telecabinSubmode?: string;
        tramSubmode?: string;
        waterSubmode?: string;
    };
    numberOfResults?: number;
    pointOfInterestFilter?: {
        exclude?: boolean;
        pointOfInterestCategory: {
            osmTag: { tag: string; value: string }[];
            pointOfInterestClassification: string[];
        }[];
    };
    type: ("location" | "stop" | "address" | "poi" | "topographicPlace")[];
}
Inherited from SharedLocationInformationRequest.DefaultRestrictionParams
- Defined in src/versions/current/requests/lir.shared.ts:6

Class LocationInformationRequest

Hierarchy

Index

Initialization

Constructors

Properties

Methods

Initialization

StaticinitWithBBOX

Parameters

Returns LocationInformationRequest

StaticinitWithLocationName

Parameters

Returns LocationInformationRequest

StaticinitWithPlaceRef

Parameters

Returns LocationInformationRequest

StaticinitWithRequestMock

Type Parameters

Parameters

Returns ReturnType<T_This["Default"]>

Example

StaticinitWithResponseMock

Type Parameters

Parameters

Returns ReturnType<T_This["Default"]>

Example

Constructors

Protectedconstructor

Parameters

Returns LocationInformationRequest

Properties

mockRequestXML

mockResponseXML

payload

See

requestInfo

Methods

Protected_fetchResponse

Parameters

Returns Promise<LocationInformationRequestResponse>

buildRequestXML

Parameters

Returns string

fetchResponse

Parameters

Returns Promise<LocationInformationRequestResponse>

ProtectedupdateRestrictions

Parameters

Returns void

Protected StaticcomputeGeoRestriction

Parameters

Returns | { rectangle: { lowerRight: { latitude: number; longitude: number }; upperLeft: { latitude: number; longitude: number }; }; } | null

Protected StaticDefaultRestrictionParams

Settings

On This Page

`Static`initWithBBOX

`Static`initWithLocationName

`Static`initWithPlaceRef

`Static`initWithRequestMock

`Static`initWithResponseMock

`Protected`constructor

`Protected`_fetchResponse

`Protected`updateRestrictions

`Protected` `Static`computeGeoRestriction

Returns
| {
rectangle: {
lowerRight: { latitude: number; longitude: number };
upperLeft: { latitude: number; longitude: number };
};
}
| null

`Protected` `Static`DefaultRestrictionParams