diff --git a/OJP/OJP_JourneySupport.xsd b/OJP/OJP_JourneySupport.xsd index cadb0435f..7552dfb50 100644 --- a/OJP/OJP_JourneySupport.xsd +++ b/OJP/OJP_JourneySupport.xsd @@ -600,12 +600,12 @@ parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set - + The desired number of trip results before the given time (at origin or destination). - + The desired number of trip results after the given time (at origin or destination). diff --git a/docs/generated/index.html b/docs/generated/index.html index f26aabd26..23c067a12 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -725,8 +725,8 @@

OJP - Open API for distributed Journey

Then, the element contains one of the following elements:

- NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

-

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

+ NumberOfResults

a

NumberOfResultsBefore

0:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

+

a

NumberOfResultsAfter

0:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them.

TimeWindow

0:1

xs:duration

Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.

UseRealtimeData

0:1

UseRealtimeData

The way real-time data should be used in the calculation of the trip.

@@ -804,8 +804,8 @@

OJP - Open API for distributed Journey

11.5. The TripPolicyGroup group

- - + + @@ -1015,8 +1015,8 @@

OJP - Open API for distributed Journey

- - + + @@ -1088,8 +1088,8 @@

OJP - Open API for distributed Journey

TripPolicyGroup

Policies that control the trip search behaviour.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

NumberOfResults

a

NumberOfResultsBefore

0:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

0:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them.

TimeWindow

0:1

xs:duration

Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.

UseRealtimeData

0:1

UseRealtimeData

The way real-time data should be used in the calculation of the trip.

Then, the element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

NumberOfResults

a

NumberOfResultsBefore

0:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

0:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them.

TimeWindow

0:1

xs:duration

Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.

UseRealtimeData

0:1

UseRealtimeData

The way real-time data should be used in the calculation of the trip.

FareParam

0:1

+FareParam

Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup).

Extension

0:1

xs:anyType

11.31. The MultiPointTripPolicyGroup group

- - + + @@ -1122,8 +1122,8 @@

OJP - Open API for distributed Journey

MultiPointTripPolicyGroup

Policies that control the multipoint trip search behaviour.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

NumberOfResults

a

NumberOfResultsBefore

0:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

0:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them.

TimeWindow

0:1

xs:duration

Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.

UseRealtimeData

0:1

UseRealtimeData

The way real-time data should be used in the calculation of the trip.

11.37. The complex type TripRefineParamStructure

- - + + @@ -1493,12 +1493,12 @@

OJP - Open API for distributed Journey

TripRefineParamStructure

Trip refinement request parameter structure.

The element contains a sequence of the following elements:

ForeignObjectRefs

0:1

xs:boolean

If true, then the request may contain object references from another system. Default is FALSE.

RefineLegRef

1:*

LegObjectId

Refers to the legs to be refined by the server. If none is given, then all legs are open for refinement (depending if the relevant system can refine them).

SystemId

0:1

xs:normalizedString

System reference to use for the refinement. If not specified the origin systems of each leg are used for the refinement.

Then, the element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

NumberOfResults

a

NumberOfResultsBefore

0:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

0:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them.

TimeWindow

0:1

xs:duration

Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.

UseRealtimeData

0:1

UseRealtimeData

The way real-time data should be used in the calculation of the trip.

The element contains a sequence of the following elements:

PersonalMode

-1:1

PersonalModes

PERSONAL MODE used either for PERSONAL MODE OF OPERATION or in ALTERNATIVE MODE OF OPERATION.

AlternativeService

-0:1

+AlternativeService

Shared mobility offer.

BookingArrangements

0:1

+BookingArrangementsContainer

Container with information on booking possibilities for this service.

SituationFullRefs

0:1

+SituationRefList

A list of references to SITUATIONs.

Extension

0:1

xs:anyType

12.24. The complex type VehiclePositionStructure

VehiclePositionStructure

Geographical and logical position of a vehicle.

The element contains a sequence of the following elements:

GeoPosition

0:1

siri:LocationStructure

Geographic position of vehicle.

Progress

0:1

VehicleProgress

Logical progress of vehicle relative to service pattern.

Bearing

0:1

siri:AbsoluteBearingType

Bearing in compass degrees in which vehicle is heading (expected to be consistent with Transmodel ROUTE -or LEG TRACK- and PATH GUIDANCE).

ProgressBetweenStops

0:1

siri:ProgressBetweenStopsStructure

Provides information about the progress of the vehicle along its current link, that is link from previous visited top to current position.

12.25. The complex type PlaceContextStructure

PlaceContextStructure

[a view of PLACE in TMv6] a PLACE and access to it by individual transport

The element contains a sequence of the following elements:

Then, the element contains one of the following elements:

a

PlaceRef

-1:1

+PlaceRef

Static place.

b

TripLocation

-1:1

+TripLocation

Location within a (moving) vehicle.

Then, the element contains one of the following elements:

a

DepArrTime

-0:1

xs:dateTime

Time when departure/arrival from/to location is required.

b

TimeAllowance

-0:1

xs:duration

Extra time needed before reaching/after leaving this location (an example of a TRIP ACCESS CONSTRAINT. In Transmodel it is modeled more extensively and could relate to ACCESS MODE e.g. walk max. 5 minutes, but cycle 10 minutes).

IndividualTransportOption

0:*

+IndividualTransportOption

Options how to access/leave the place by individual transport.

12.26. The NumberOfResultsGroup group

- - + +

NumberOfResultsGroup

parameter to control the number of TRIP results before/after a point in time. May NOT be used when departure time at origin AND arrival time at destination are set

NumberOfResults

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

NumberOfResults

NumberOfResultsBefore

0:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

NumberOfResultsAfter

0:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

12.27. The BaseTripPolicyGroup group

- - + + diff --git a/examples/functions/trip/TR_17_request_number_results_before_after.xml b/examples/functions/trip/TR_17_request_number_results_before_after.xml new file mode 100644 index 000000000..9a97a3783 --- /dev/null +++ b/examples/functions/trip/TR_17_request_number_results_before_after.xml @@ -0,0 +1,97 @@ + + + + + 2020-01-31T12:30:00Z + 3CC3C04A-20A0-4B12-AC46-5A7843E328A7 + + 2020-01-31T12:30:00Z + + + 8503000 + + Bern + + + 2020-01-30T12:30:00Z + + + + 8505000 + + Luzern + + + + + 2 + PT60M + + fastest + + + + + + + 2020-01-31T12:30:00Z + + + 8503000 + + Bern + + + 2020-01-30T12:30:00Z + + + + 8505000 + + Luzern + + + + + 2 + PT60M + + fastest + + + + + + + 2020-01-31T12:30:00Z + + + 8503000 + + Bern + + + 2020-01-30T12:30:00Z + + + + 8505000 + + Luzern + + + + + 3 + 4 + PT60M + + fastest + + + + + + + +

BaseTripPolicyGroup

Policies that control the trip search behaviour for both public and individual transport.

The element contains one of the following elements:

NumberOfResults

a

NumberOfResultsBefore

1:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

1:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

NumberOfResults

a

NumberOfResultsBefore

0:1

xs:nonNegativeInteger

The desired number of trip results before the given time (at origin or destination).

a

NumberOfResultsAfter

0:1

xs:nonNegativeInteger

The desired number of trip results after the given time (at origin or destination).

BaseTripPolicy

b

NumberOfResults

-0:1

xs:positiveInteger

The number of trip results that the user wants to see at least (TRIP REQUEST POLICY.maximumNumberofJourneys). Be aware that some implementatins will deliver one of the TripResults before the indicated departure time. This means one always has to check the results against the parameters before using them.

TimeWindow

0:1

xs:duration

Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.

UseRealtimeData

0:1

UseRealtimeData

The way real-time data should be used in the calculation of the trip.