From 27387be69cbb3ca68c28c4c4fc5e776e71621c19 Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Wed, 19 Jul 2023 21:38:57 +0200 Subject: [PATCH 01/10] Added TripParams, changes in examples --- OJP/OJP_Trips.xsd | 12 +- .../trip_change/ChangeTripRequest.xml | 213 ------------------ .../trip_change/ChangeTripResponse.xml | 185 --------------- .../TripChange_001_Request_laterDeparture.xml | 7 +- 4 files changed, 9 insertions(+), 408 deletions(-) delete mode 100644 examples/functions/trip_change/ChangeTripRequest.xml delete mode 100644 examples/functions/trip_change/ChangeTripResponse.xml diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 0a1a8d3b9..b379c5d9e 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -1768,7 +1768,7 @@ - Refers to the legs to be changed by the server. + Refers to the transfer legs to be changed by the server. @@ -1786,15 +1786,9 @@ Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested. - - - - Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup). - - - + - Transport operators to include/exclude. + Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest. diff --git a/examples/functions/trip_change/ChangeTripRequest.xml b/examples/functions/trip_change/ChangeTripRequest.xml deleted file mode 100644 index f266957fe..000000000 --- a/examples/functions/trip_change/ChangeTripRequest.xml +++ /dev/null @@ -1,213 +0,0 @@ - - - - - 2022-12-19T12:00:00Z - IRMA - - 2022-12-19T12:00:00Z - 4711 - - 1 - 3 - SBB:prod - full - true - true - true - difficult - comfortable - - OSDM-NOVA-Prod - Senior - Disabled - - 85 - - - - - ID-5A9D01A0-CF49-41E7-A674-D37167E33AEF - - ID-5A9D01A0-CF49-41E7-A674-D37167E33AEF - PT2H18M - 2020-09-30T10:03:00Z - 2020-09-30T12:21:00Z - 0 - 125484 - - 1 - - - 8506302 - - St. Gallen - - - 4 - - - 2020-09-30T10:03:00Z - - 1 - - - 8505000 - - Luzern - - - 3 - - - 2020-09-30T12:21:00Z - - 15 - - - 2020-09-30 - 910DG:Y:R:j20:210 - - 910DG:Y - R - - rail - local - - Zug - - - IR - - - - empty - - - 82 - - - - Reservierung möglich - - A___R - - - - Bar - - A___B - - - - Maskenpflicht für Reisende ab 12 Jahren - - A__OM - - - de:00000:-1 - - Luzern - - - - - Voralpen-Express - - - 2020 - - - - - - 2 - - walk - - 8505000 - - Luzern - - - - - 47.042666496 - 8.306332108 - - - Taxiplatz Luzern - - - PT3M - - - - 3 - - - - 47.042666496 - 8.306332108 - - - Taxiplatz Luzern - - - - - 47.06 - 8.32 - - - Destination - - - - demandResponsive - - ch:1:sboid:12391912 - - - - - onBoarding - - - - - PT13M - - - - - - - - ch:1:sboid:1230123 - New rail company - - - - - - 8530813 - - Zürich Kreuzplatz - - 23026261:27 - - - Zürich - - - 8.55408 - 47.36488 - - - - - - - - diff --git a/examples/functions/trip_change/ChangeTripResponse.xml b/examples/functions/trip_change/ChangeTripResponse.xml deleted file mode 100644 index 54072f05b..000000000 --- a/examples/functions/trip_change/ChangeTripResponse.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - 2022-12-01T17:54:38Z - OJPCH_Prod - true - - 2022-12-01T17:54:38Z - 4711 - true - 421 - 4 - - ID-5A9D01A0-CF49-41E7-A674-D37167E33AEF - - ID-5A9D01A0-CF49-41E7-A674-D37167E33AEF - PT2H18M - 2020-09-30T10:03:00Z - 2020-09-30T12:21:00Z - 0 - 125484 - - - 1 - - - 8506302 - - St. Gallen - - - 4 - - - 5 - - - - 2020-09-30T10:03:00Z - 2020-09-30T10:06:00Z - - - 1 - - - 8505000 - - Luzern - - - 3 - - - 2020-09-30T12:21:00Z - - 15 - - - 2020-09-30 - 910DG:Y:R:j20:210 - - 910DG:Y - R - - rail - local - - Zug - - - IR - - - - empty - - - 82 - - - - Reservierung möglich - - A___R - - - - Bar - - A___B - - - - de:00000:-1 - - Luzern - - - - - Voralpen-Express - - - 2020 - - - - - - 2 - - - walk - - 8505000 - - Luzern - - - - - 47.042666496 - 8.306332108 - - - Taxiplatz Luzern - - - PT3M - - - - - 3 - - - - 47.042666496 - 8.306332108 - - - Taxiplatz Luzern - - - - - 47.06 - 8.31 - - - - New destination - - - - - demandResponsive - - ch:1:sboid:12391912 - - - - - onBoarding - - - - - PT11M - - - - - - - - - diff --git a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml index 1305f1f5e..267969045 100644 --- a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml +++ b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml @@ -7,8 +7,13 @@ 2020-06-16T10:00:00Z - 3 + 2 laterDeparture + + true + 3 + fastest + ID-83BFBC80-71F5-4287-9359-55F839207004 From c7857d542da714ca13f580608f51ee7438f59976 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 19 Jul 2023 19:51:25 +0000 Subject: [PATCH 02/10] Lint and update documentation tables --- docs/generated/index.html | 62 +-------------------------------------- 1 file changed, 1 insertion(+), 61 deletions(-) diff --git a/docs/generated/index.html b/docs/generated/index.html index 1bc492cfd..d4e786c93 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -1150,67 +1150,7 @@

OJP - Open API for distributed Journey TripChangeRequest

ChangeParams

0:1

+TripChangeParam

Options to control the change.

TripResult

1:1

+TripResult

The trip result to be changed by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

-

11.40. The complex type TripChangeParamStructure

- - - - - - - - - - - - - - - - - | | `easy` -| - - - - - | | `medium` -| - - - - - | | `difficult` -| - - - - - - - - - | | `fast` -| - - - - - | | `green` -| - - - - - | | `comfortable` -| - - - - - - - -

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:*

LegObjectId

Refers to the legs to be changed by the server.

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.

EarlierArrivalLaterDeparture

0:1

EarlierArrivalLaterDeparture

Whether the requested journey leg of the passed trip should arrive earlier or depart later to give the passenger more time to make the interchange.

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

BaseTripContentFilter

IncludeTrackSections

0:1

xs:boolean

Whether the result should include TrackSection elements to describe the geographic route of each journey leg.

IncludeLegProjection

0:1

xs:boolean

Whether the result should include the geographic projection (coordinates) of each journey leg.

IncludeTurnDescription

0:1

xs:boolean

Whether the result should include turn-by-turn instructions for each journey leg.

IncludeAccessFeatures

0:1

xs:boolean

Whether the result should include the access features (stairs, elevator, etc.) on each path link.

IncludeAccessFeaturesStatus

0:1

xs:boolean

Whether the result should include real time status of access features to indicate broken equipment.

IncludeAccessibilityDetails

0:*

AccessibilityDetailsProfile

Which accessibility features and other accessibility-related information to retrieve (e.g. guidance text for the visually impaired).

IncludePlacesContext

0:1

xs:boolean

Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true.

IncludeSituationsContext

0:1

xs:boolean

Wheter the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true

TripContentFilter

IncludeIntermediateStops

0:1

xs:boolean

Whether the result should include intermediate stops (between the passenger's board and alight stops).

IncludeAlternativeOptions

0:1

xs:boolean

Whether alternative options should be presented as well. Mainly important for dominated journeys or in the case of ContinuousLegs the second-best route. Should be optimised for the user expectance (see. e.g https://theses.hal.science/tel-01848737). However, what the alternative options are may vary widely depending on the optimisation methods and filters.

IncludeFare

0:1

xs:boolean

Whether the result should include fare information.

IncludeOperatingDays

0:1

xs:boolean

Whether the result should include operating day information - as encoded bit string and in natural language.

HikingProfile

0:1

Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: possible explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen

CyclingProfile

0:1

Cycling profile of the user (especially for sportive activities).

TripSummaryOnly

0:1

xs:boolean

If true, then the response will contain only summaries of the found trips. Default is false.

FareParam

0:1

+FareParam

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

OperatorFilter

0:1

+OperatorFilter

Transport operators to include/exclude.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

+

TripChangeResponseGroup

Trip change response structure.

11.40. The complex type TripChangeParamStructure

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:*

LegObjectId

Refers to the transfer legs to be changed by the server.

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.

EarlierArrivalLaterDeparture

0:1

EarlierArrivalLaterDeparture

Whether the requested journey leg of the passed trip should arrive earlier or depart later to give the passenger more time to make the interchange.

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

TripParams

0:1

+TripParam

Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

TripChangeResponseGroup

Trip change response structure.

TripChangeResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:1

+TripResult

The trip results refined by the server.

11.42. The toplevel element TripChangeProblemType

TripChangeProblemType

TripChangeProblemType (↔ ErrorType)

From 52f43dc913977f90caab2d56a5561511290f8a0d Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Thu, 20 Jul 2023 21:13:46 +0200 Subject: [PATCH 03/10] Update examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthias Günter --- .../trip_change/TripChange_001_Request_laterDeparture.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml index 267969045..7bf5e4608 100644 --- a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml +++ b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml @@ -11,7 +11,7 @@ laterDeparture true - 3 + 1 fastest From d401ff0c68a5c43ac71535cd7f14c955bb1d0405 Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Thu, 20 Jul 2023 21:14:02 +0200 Subject: [PATCH 04/10] Update OJP/OJP_Trips.xsd MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthias Günter --- OJP/OJP_Trips.xsd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index b379c5d9e..7abe70669 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -1768,7 +1768,7 @@ - Refers to the transfer legs to be changed by the server. + Refers to the legs to be changed by the server. From e842792996b2b5ad0e328ca595e065eb7103f034 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 20 Jul 2023 19:14:42 +0000 Subject: [PATCH 05/10] Lint and update documentation tables --- docs/generated/index.html | 2 +- .../trip_change/TripChange_001_Request_laterDeparture.xml | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/generated/index.html b/docs/generated/index.html index d4e786c93..9afd25a7b 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -1150,7 +1150,7 @@

OJP - Open API for distributed Journey TripChangeRequest

ChangeParams

0:1

+TripChangeParam

Options to control the change.

TripResult

1:1

+TripResult

The trip result to be changed by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

-

11.40. The complex type TripChangeParamStructure

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:*

LegObjectId

Refers to the transfer legs to be changed by the server.

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.

EarlierArrivalLaterDeparture

0:1

EarlierArrivalLaterDeparture

Whether the requested journey leg of the passed trip should arrive earlier or depart later to give the passenger more time to make the interchange.

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

TripParams

0:1

+TripParam

Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

+

TripChangeResponseGroup

Trip change response structure.

11.40. The complex type TripChangeParamStructure

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:*

LegObjectId

Refers to the legs to be changed by the server.

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.

EarlierArrivalLaterDeparture

0:1

EarlierArrivalLaterDeparture

Whether the requested journey leg of the passed trip should arrive earlier or depart later to give the passenger more time to make the interchange.

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

TripParams

0:1

+TripParam

Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

TripChangeResponseGroup

Trip change response structure.

TripChangeResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:1

+TripResult

The trip results refined by the server.

11.42. The toplevel element TripChangeProblemType

TripChangeProblemType

TripChangeProblemType (↔ ErrorType)

diff --git a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml index 7bf5e4608..00904e53a 100644 --- a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml +++ b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml @@ -11,7 +11,8 @@ laterDeparture true - 1 + 1 + fastest From 677a85d8186085b257263656d0f2afe34524b4e9 Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Thu, 20 Jul 2023 21:30:41 +0200 Subject: [PATCH 06/10] Annotations and parameter name --- OJP/OJP_Trips.xsd | 16 ++++++++++------ .../TripChange_001_Request_laterDeparture.xml | 2 +- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 7abe70669..4b4bd0918 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -1768,7 +1768,11 @@ +<<<<<<< HEAD + Refers to the transfer legs to be changed by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or sharing legs for which the exact times shall be retrieved for a specific operator. +======= Refers to the legs to be changed by the server. +>>>>>>> e842792996b2b5ad0e328ca595e065eb7103f034 @@ -1776,9 +1780,9 @@ System reference to use for the refinement. If not specified the origin systems of each leg are used for the refinement. - + - Whether the requested journey leg of the passed trip should arrive earlier or depart later to give the passenger more time to make the interchange. + Whether to extend the initial time interval of the ChangeLeg towards the front or the back of the trip (earlier respectively later times). @@ -1794,13 +1798,13 @@ - + - Prefer earlier arrival or later departure + Prefer earlier or later times. - - + + diff --git a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml index 00904e53a..9e648373a 100644 --- a/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml +++ b/examples/functions/trip_change/TripChange_001_Request_laterDeparture.xml @@ -8,7 +8,7 @@ 2020-06-16T10:00:00Z 2 - laterDeparture + extendToBack true 1 From 520aa7d702299d8cefcb7f4eb671bc08b1123509 Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Thu, 20 Jul 2023 21:39:00 +0200 Subject: [PATCH 07/10] Strange copy-paste error --- OJP/OJP_Trips.xsd | 4 ---- 1 file changed, 4 deletions(-) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 4b4bd0918..8324ebe26 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -1768,11 +1768,7 @@ -<<<<<<< HEAD Refers to the transfer legs to be changed by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or sharing legs for which the exact times shall be retrieved for a specific operator. -======= - Refers to the legs to be changed by the server. ->>>>>>> e842792996b2b5ad0e328ca595e065eb7103f034 From 5b4994ca94d105975912f120e81076b6d9ee62ad Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 20 Jul 2023 19:39:40 +0000 Subject: [PATCH 08/10] Lint and update documentation tables --- docs/generated/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/generated/index.html b/docs/generated/index.html index 9afd25a7b..c878357c1 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -660,7 +660,7 @@

OJP - Open API for distributed Journey

→‍siri:ServiceFacilityGroup

JourneyTrack

0:1

+LegTrack

Geographic embedding of this journey. The entire journey is regarded as one leg.

Extension

0:1

xs:anyType

10.8. The toplevel element TripInfoProblemType

TripInfoProblemType

TripInfoProblemType (↔ ErrorType)

-

11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning

11.1. Simple type definitions

-

AccessFeatureStatusEnumeration

unknown | available | partiallyAvailable | notAvailable

Allowed values for status of the access feature.

AccessFeatureTypeEnumeration

elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown

Allowed values for a AccessFeature.

AccessibilityFeatureTypesEnumeration

lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator

Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to).

EarlierArrivalLaterDepartureType

laterDeparture | earlierArrival

Prefer earlier arrival or later departure

FeasibilityEnumeration

allAccessFeaturesAvailable | accessFeatureNotAvailable | accessFeaturePartiallyAvailable | accessFeatureWithUnknownAvailability | seeSituations

Allowed values for the feasibility of a TRIP or part of a TRIP.

GuidanceAdviceEnumeration

origin | destination | continue | keep | turn | leave | enter | enter_roundabout | stay_in_roundabout | leave_roundabout | enter_builtup_area | leave_builtup_area | freewayAccessRamp | unknown_lane_choice | left_lane | middle_lane | right_lane | unknown_turning_kind

Various types of guidance advice given to traveller. Suitable values may differ by MODE (e.g. a car driver needs different advice than a person walking for a transfer.

LegObjectIdType

ObjectIdType

Type for identifier of a NeTEx Object.

MultiPointTripResultObjectIdType

ObjectIdType

Type for identifier of a NeTEx Object.

MultiPointTypeEnumeration

anyPoint | eachOrigin | eachDestination | eachOriginDestination | somePoints

How the multiple origin/destination points should be considered. +

11. OJP/OJP_Trips.xsd - Request and response definitions for trip requests and distributed journey planning

11.1. Simple type definitions

AccessFeatureStatusEnumeration

unknown | available | partiallyAvailable | notAvailable

Allowed values for status of the access feature.

AccessFeatureTypeEnumeration

elevator | stairs | seriesOfStairs | singleStep | seriesOfSingleSteps | escalator | travelator | ramp | footpath | shuttle | other | unkown

Allowed values for a AccessFeature.

AccessibilityFeatureTypesEnumeration

lowFloorAccess | stepFreeAccess | accessWithSteps | slidingStep | raisedKerb | narrowEntrance | wheelchairLift | manualRamp | automaticRamp | suitableForWheelchairs | suitableForUnassistedWheelchairs | suitableForHeaviliyDisabled | suitableForPushchairs | suitableForBicycles | tactilePlatformEdges | tactileGuidingStrips | tactileOrAuditorySigns | visualSigns | elevatorWithTactileButtons | elevatorWithAcousticAnnouncements | audioInformation | audioForHearingImpaired | visualDisplays | displaysForVisuallyImpaired | largePrintTimetables | boardingAssistance | onboardAssistance | unaccompaniedMinorAssistance | barrier | validator

Allowed values for AccessibilityFeature (for mobility and sensory impairments, assistance and important elements to pay attention to).

ExtendToFrontOrBackType

extendToFront | extendToBack

Prefer earlier or later times.

FeasibilityEnumeration

allAccessFeaturesAvailable | accessFeatureNotAvailable | accessFeaturePartiallyAvailable | accessFeatureWithUnknownAvailability | seeSituations

Allowed values for the feasibility of a TRIP or part of a TRIP.

GuidanceAdviceEnumeration

origin | destination | continue | keep | turn | leave | enter | enter_roundabout | stay_in_roundabout | leave_roundabout | enter_builtup_area | leave_builtup_area | freewayAccessRamp | unknown_lane_choice | left_lane | middle_lane | right_lane | unknown_turning_kind

Various types of guidance advice given to traveller. Suitable values may differ by MODE (e.g. a car driver needs different advice than a person walking for a transfer.

LegObjectIdType

ObjectIdType

Type for identifier of a NeTEx Object.

MultiPointTripResultObjectIdType

ObjectIdType

Type for identifier of a NeTEx Object.

MultiPointTypeEnumeration

anyPoint | eachOrigin | eachDestination | eachOriginDestination | somePoints

How the multiple origin/destination points should be considered. Note: Unfortunately this element was underdefined before and this resulted in different implementations. Note: MultiPointType trumps the number of results. If the algorithm thinks it necessary to provide more results, it should.

OptimisationMethodEnumeration

fastest | minChanges | leastWalking | leastCost | leastDistance | earliestArrival | latestDeparture | earliestArrivalAndLatestDeparture | minNonLevelEntrances | minStairs | bestForVisualImpairment | bestForAuditoryImpairment | environmentalSafety | extraSafe | extraReliable | scenic | quietTravel

The types of algorithm that can be used for planning a journey (fastest, least walking, etc.). Only one method can be used. Each one really is a whole set of a policy, which is defined below. E.g. fastest also includes least transfers as a second criteria, some modes are excluded usually by default. Implementations might differ (slightly). Also some strategies might not be implemented. The most important strategies are marked.

TransitionEnumeration

up | down | level | upAndDown | downAndUp

Transition types for interchanges.

TripChangeProblemTypeEnumeration

TRIPCHANGE_NOLATERTRIPFOUND | TRIPCHANGE_NOEARLIERTRIPFOUND | TRIPCHANGE_INVALIDLEGREF | TRIPCHANGE_INVALIDOPERATOR | TRIPCHANGE_NOVEHICLEAVAILABLE | TRIPCHANGE_OTHER

Types of problems that may be returned in responses to TRIPCHANGE requests.

TripObjectIdType

ObjectIdType

Type for identifier of a NeTEx Object.

TripProblemTypeEnumeration

TRIP_NOTRIPFOUND | TRIP_ORIGINUNKNOWN | TRIP_DESTINATIONUNKNOWN | TRIP_VIAUNKNOWN | TRIP_NOTVIAUNKNOWN | TRIP_NOCHANGEATUNKNOWN | TRIP_NOORIGIN | TRIP_NODESTINATION | TRIP_ORIGINDESTINATIONIDENTICAL | TRIP_DATETIMEERROR | TRIP_TIMEWINDOWTOOLARGE | TRIP_DEPARTUREAFTERARRIVAL | TRIP_DATEOUTOFRANGE | TRIP_ORIGINEQUIVALENT | TRIP_DESTINATIONEQUIVALENT | TRIP_VIAEQUIVALENT | TRIP_REALTIMEINCOMPLETE | TRIP_ITTIMEEXTENDED | TRIP_ITMODECHANGED | TRIP_INCONVENIENTWAITING | TRIP_MULTIPOINT_NOTALLPOINTSCOVERED | TRIP_MULTIPOINT_TOOMANYPOINTS | TRIP_MULTIPOINT_TYPE_NOT_SUPPORTED | TRIP_REFINE_LEG_UNKNOWN | REFINE_OBJECTNOTFOUND | REFINE_PROFILENOTSUPPORTED | TRIP_OTHER

Types of problems that may be returned in responses to Trip requests.

TripResultObjectIdType

ObjectIdType

Type for identifier of a NeTEx Object.

TurnActionEnumeration

straight_on | half_right | right | sharp_right | uturn | sharp_left | left | half_left | up | down | unknown_turn_action

The range of possible turns that can be described.

11.2. The TripRequestGroup group

@@ -1150,7 +1150,7 @@

OJP - Open API for distributed Journey

-

TripRequestGroup

Trip request structure.

TripChangeRequest

ChangeParams

0:1

+TripChangeParam

Options to control the change.

TripResult

1:1

+TripResult

The trip result to be changed by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

11.40. The complex type TripChangeParamStructure

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:*

LegObjectId

Refers to the legs to be changed by the server.

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.

EarlierArrivalLaterDeparture

0:1

EarlierArrivalLaterDeparture

Whether the requested journey leg of the passed trip should arrive earlier or depart later to give the passenger more time to make the interchange.

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

TripParams

0:1

+TripParam

Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

+

TripChangeResponseGroup

Trip change response structure.

11.40. The complex type TripChangeParamStructure

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:*

LegObjectId

Refers to the transfer legs to be changed by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or sharing legs for which the exact times shall be retrieved for a specific operator.

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.

ExtendToFrontOrBack

0:1

Extend

Whether to extend the initial time interval of the ChangeLeg towards the front or the back of the trip (earlier respectively later times).

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

TripParams

0:1

+TripParam

Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

TripChangeResponseGroup

Trip change response structure.

TripChangeResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:1

+TripResult

The trip results refined by the server.

11.42. The toplevel element TripChangeProblemType

TripChangeProblemType

TripChangeProblemType (↔ ErrorType)

From ca14b4314334738af75c31af0906eb0336ab9823 Mon Sep 17 00:00:00 2001 From: trurlurl <82838870+trurlurl@users.noreply.github.com> Date: Mon, 24 Jul 2023 16:27:23 +0200 Subject: [PATCH 09/10] ChangeLegRef cardinality --- OJP/OJP_Trips.xsd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/OJP/OJP_Trips.xsd b/OJP/OJP_Trips.xsd index 8324ebe26..b81fdf780 100644 --- a/OJP/OJP_Trips.xsd +++ b/OJP/OJP_Trips.xsd @@ -1766,9 +1766,9 @@ Trip change request parameter structure. - + - Refers to the transfer legs to be changed by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or sharing legs for which the exact times shall be retrieved for a specific operator. + Refers to the leg to be adapted by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or a sharing leg for which the exact times shall be retrieved for a specific operator. From 84baa7abbb3325ba9c78803b4ff5541698bf482c Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 24 Jul 2023 14:30:24 +0000 Subject: [PATCH 10/10] Lint and update documentation tables --- docs/generated/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/generated/index.html b/docs/generated/index.html index c878357c1..371321616 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -1150,7 +1150,7 @@

OJP - Open API for distributed Journey

TripChangeRequest

ChangeParams

0:1

+TripChangeParam

Options to control the change.

TripResult

1:1

+TripResult

The trip result to be changed by the server.

TripResponseContext

0:1

+ResponseContext

Context to hold objects, which are referenced within the response.

11.40. The complex type TripChangeParamStructure

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:*

LegObjectId

Refers to the transfer legs to be changed by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or sharing legs for which the exact times shall be retrieved for a specific operator.

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.

ExtendToFrontOrBack

0:1

Extend

Whether to extend the initial time interval of the ChangeLeg towards the front or the back of the trip (earlier respectively later times).

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

TripParams

0:1

+TripParam

Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

+

TripChangeResponseGroup

Trip change response structure.

11.40. The complex type TripChangeParamStructure

TripChangeParamStructure

Trip change request parameter structure.

The element contains a sequence of the following elements:

ChangeLegRef

1:1

LegObjectId

Refers to the leg to be adapted by the server. Typical usage: either a transfer leg representing an interchange that is considered too short or a sharing leg for which the exact times shall be retrieved for a specific operator.

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.

ExtendToFrontOrBack

0:1

Extend

Whether to extend the initial time interval of the ChangeLeg towards the front or the back of the trip (earlier respectively later times).

AdditionalWaitingTime

0:1

xs:duration

Absolute time in minutes the passenger wants additionally to make the interchange. If another TransferLeg is needed (e.g. since another quay is used for the found arrival/departure) this is taken into account. If not passed, the next best arrival/departure is requested.

TripParams

0:1

+TripParam

Options to control the search behaviour and response contents. They should be largely the same as used as in the initial OJPTripRequest.

Extension

0:1

xs:anyType

11.41. The TripChangeResponseGroup group

TripChangeResponseGroup

Trip change response structure.

TripChangeResponse

TripResponseContext

0:1

+ResponseContext

Context to hold trip response objects that occur frequently.

TripResult

0:1

+TripResult

The trip results refined by the server.

11.42. The toplevel element TripChangeProblemType

TripChangeProblemType

TripChangeProblemType (↔ ErrorType)