Class OJPv1_StopEventRequest

StopEventRequest (SER) class for OJP 1.0

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

initWithPlaceRefAndDate - use PlaceRef ids + date

Hierarchy

SharedStopEventRequest<{ fetchResponse: OJPv1_StopEventRequestResponse }>
- OJPv1_StopEventRequest

Index

Initialization

`Static`initWithPlaceRefAndDate

initWithPlaceRefAndDate(placeRefS: string, date?: Date): OJPv1_StopEventRequest
Creates a new StopEventRequest with the given place reference and date
Parameters
- placeRefS: string
  The stop point reference ID (e.g. "8507000" for Bern)
- date: Date = ...
  The date and time for the stop event request (defaults to current date/time)
Returns OJPv1_StopEventRequest
- Defined in src/versions/legacy/v1/requests/ser.ts:74

`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 SharedStopEventRequest.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 SharedStopEventRequest.initWithResponseMock
- Defined in src/versions/current/requests/base.ts:64

Constructors

`Protected`constructor

new OJPv1_StopEventRequest(
    location: {
        depArrTime?: string;
        placeRef: {
            geoPosition?: { latitude: number; longitude: number };
            locationName: { text: string };
            stopPlaceRef?: string;
            stopPointRef?: string;
        };
    },
    params?:
        | {
            includeAllRestrictedLines?: boolean;
            includeOnwardCalls?: boolean;
            includePreviousCalls?: boolean;
            numberOfResults?: number;
            stopEventType?: "both"
            | "departure"
            | "arrival";
            useRealtimeData?: "none" | "full" | "explanatory";
        }
        | undefined,
): OJPv1_StopEventRequest
Parameters
- location: {
      depArrTime?: string;
      placeRef: {
          geoPosition?: { latitude: number; longitude: number };
          locationName: { text: string };
          stopPlaceRef?: string;
          stopPointRef?: string;
      };
  }
- params:
      | {
          includeAllRestrictedLines?: boolean;
          includeOnwardCalls?: boolean;
          includePreviousCalls?: boolean;
          numberOfResults?: number;
          stopEventType?: "both"
          | "departure"
          | "arrival";
          useRealtimeData?: "none" | "full" | "explanatory";
      }
      | undefined = undefined
Returns OJPv1_StopEventRequest
Overrides SharedStopEventRequest <{ fetchResponse: OJPv1_StopEventRequestResponse }>.constructor
- Defined in src/versions/legacy/v1/requests/ser.ts:32

Properties

mockRequestXML

mockRequestXML: string | null

mockResponseXML

mockResponseXML: string | null

payload

payload: {
    location: {
        depArrTime?: string;
        placeRef: {
            geoPosition?: { latitude: number; longitude: number };
            locationName: { text: string };
            stopPlaceRef?: string;
            stopPointRef?: string;
        };
    };
    params?: {
        includeAllRestrictedLines?: boolean;
        includeOnwardCalls?: boolean;
        includePreviousCalls?: boolean;
        numberOfResults?: number;
        stopEventType?: "both"
        | "departure"
        | "arrival";
        useRealtimeData?: "none" | "full" | "explanatory";
    };
    requestTimestamp: string;
}

The payload object that gets serialized to XML for the request

requestInfo

requestInfo: RequestInfo

Methods

`Protected`_fetchResponse

_fetchResponse(sdk: SDK<"1.0">): Promise<OJPv1_StopEventRequestResponse>
Parameters
- sdk: SDK<"1.0">
Returns Promise<OJPv1_StopEventRequestResponse>
Overrides SharedStopEventRequest._fetchResponse
- Defined in src/versions/legacy/v1/requests/ser.ts:121

buildRequestXML

buildRequestXML(
    language: Language,
    requestorRef: string,
    xmlConfig: XML_Config,
): string
Builds the XML request string for the SER
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
Overrides SharedStopEventRequest.buildRequestXML
- Defined in src/versions/legacy/v1/requests/ser.ts:100

fetchResponse

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

`Protected` `Static`DefaultRequestParams

DefaultRequestParams(
    version?: OJP_VERSION,
): {
    includeAllRestrictedLines?: boolean;
    includeOnwardCalls?: boolean;
    includePreviousCalls?: boolean;
    numberOfResults?: number;
    stopEventType?: "both" | "departure" | "arrival";
    useRealtimeData?: "none" | "full" | "explanatory";
}
Parameters
- version: OJP_VERSION = '2.0'
Returns {
    includeAllRestrictedLines?: boolean;
    includeOnwardCalls?: boolean;
    includePreviousCalls?: boolean;
    numberOfResults?: number;
    stopEventType?: "both" | "departure" | "arrival";
    useRealtimeData?: "none" | "full" | "explanatory";
}
Inherited from SharedStopEventRequest.DefaultRequestParams
- Defined in src/versions/current/requests/ser.shared.ts:7

Class OJPv1_StopEventRequest

Hierarchy

Index

Initialization

Constructors

Properties

Methods

Initialization

StaticinitWithPlaceRefAndDate

Parameters

Returns OJPv1_StopEventRequest

StaticinitWithRequestMock

Type Parameters

Parameters

Returns ReturnType<T_This["Default"]>

Example

StaticinitWithResponseMock

Type Parameters

Parameters

Returns ReturnType<T_This["Default"]>

Example

Constructors

Protectedconstructor

Parameters

Returns OJPv1_StopEventRequest

Properties

mockRequestXML

mockResponseXML

payload

requestInfo

Methods

Protected_fetchResponse

Parameters

Returns Promise<OJPv1_StopEventRequestResponse>

buildRequestXML

Parameters

Returns string

fetchResponse

Parameters

Returns Promise<OJPv1_StopEventRequestResponse>

Protected StaticDefaultRequestParams

Parameters

Returns { includeAllRestrictedLines?: boolean; includeOnwardCalls?: boolean; includePreviousCalls?: boolean; numberOfResults?: number; stopEventType?: "both" | "departure" | "arrival"; useRealtimeData?: "none" | "full" | "explanatory";}

Settings

On This Page

`Static`initWithPlaceRefAndDate

`Static`initWithRequestMock

`Static`initWithResponseMock

`Protected`constructor

`Protected`_fetchResponse

`Protected` `Static`DefaultRequestParams

Returns {
includeAllRestrictedLines?: boolean;
includeOnwardCalls?: boolean;
includePreviousCalls?: boolean;
numberOfResults?: number;
stopEventType?: "both" | "departure" | "arrival";
useRealtimeData?: "none" | "full" | "explanatory";
}