diff --git a/docs/generated/index.html b/docs/generated/index.html index c090732b4..aade2b628 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -61,13 +61,13 @@
OJPFareRequest
OJPFareRequestStructure
OJPFareDelivery
OJPFareDeliveryStructure
OJPPlaceInformationRequest
OJPPlaceInformationRequestStructure
OJPPlaceInformationDelivery
OJPPlaceInformationDeliveryStructure
OJPExchangePointsRequest
OJPExchangePointsRequestStructure
OJPExchangePointsDelivery
OJPExchangePointsDeliveryStructure
OJPStopEventRequest
OJPStopEventRequestStructure
OJPStopEventDelivery
OJPStopEventDeliveryStructure
OJPTripInfoRequest
OJPTripInfoRequestStructure
OJPTripInfoDelivery
OJPTripInfoDeliveryStructure
OJPTripRequest
OJPTripRequestStructure
OJPTripDelivery
OJPTripDeliveryStructure
OJPMultiPointTripRequest
OJPMultiPointTripRequestStructure
OJPMultiPointTripDelivery
OJPMultiPointTripDeliveryStructure
OJPTripRefineRequest
OJPTripRefineRequestStructure
OJPTripRefineDelivery
OJPTripRefineDeliveryStructure
OJPAvailabilityRequest
OJPAvailabilityRequestStructure
OJPAvailabilityDelivery
OJPAvailabilityDeliveryStructure
OJPLineInformationRequest
OJPLineInformationRequestStructure
OJPLineInformationDelivery
OJPLineInformationDeliveryStructure
MessageIntegrityPropertiesGroup
groupServiceRequestContextGroup
groupServiceResponseContextGroup
groupAbstractOJPServiceRequestStructure
PlacesStructure
Operators_RelStructure
ResponseContextStructure
OJPGenericProblemStructure
FareRequestGroup
groupStopFareRequestStructure
StaticFareRequestStructure
TripFareRequestStructure
MultiTripFareRequestStructure
FareResponseGroup
groupFareResultStructure
StopFareResultStructure
StaticFareResultStructure
TripFareProductReferenceStructure
MultiTripFareResultStructure
FareAuthorityRefStructure
FareAuthorityRef
FareAuthorityGroup
groupTariffZoneRefStructure
TariffZoneRef
TariffZoneStructure
TariffZoneListInAreaStructure
TariffZoneRefListStructure
ContactDetailsStructure
BookingMethodListOfEnumerations
PurchaseMomentListOfEnumerations
BookingProcessListOfEnumerations
GroupBookingListOfEnumerations
BookingArrangementsStructure
BookingArrangementsGroup
groupBookingArrangementsContainerStructure
FareProductRefStructure
FareProductRef
EntitlementProductListStructure
EntitlementProductStructure
FareProductStructure
FareProductPriceGroup
groupFareProductValidityGroup
groupFareProductBookingGroup
groupTripLegRangeGroup
groupTripFareResultStructure
FarePassengerStructure
FareDataFilterGroup
groupFareParamStructure
FareProblemStructure
FareAuthorityRefStructure
FareAuthorityRef
FareAuthorityGroup
groupTariffZoneRefStructure
TariffZoneRef
TariffZoneStructure
TariffZoneListInAreaStructure
TariffZoneRefListStructure
ContactDetailsStructure
BookingMethodListOfEnumerations
PurchaseMomentListOfEnumerations
BookingProcessListOfEnumerations
GroupBookingListOfEnumerations
BookingArrangementsStructure
BookingArrangementsGroup
groupBookingArrangementsContainerStructure
FareProductRefStructure
FareProductRef
EntitlementProductListStructure
EntitlementProductStructure
FareProductStructure
FareProductPriceGroup
groupFareProductValidityGroup
groupFareProductBookingGroup
groupLegRangeGroup
groupTripFareResultStructure
FarePassengerStructure
FareDataFilterGroup
groupFareParamStructure
FareProblemStructure
PlaceInformationRequestGroup
groupPlaceInformationResponseGroup
groupInitialPlaceInputStructure
PlaceParamStructure
GeoRestrictionsStructure
GeoCircleStructure
GeoRectangleStructure
GeoAreaStructure
PlaceResultStructure
PlacePolicyGroup
groupPlaceDataFilterGroup
groupPlaceSortingGroup
groupExchangePointsRequestGroup
groupExchangePointsParamStructure
ExchangePointsDataFilterGroup
groupExchangePointsPolicyGroup
groupExchangePointsResponseGroup
groupExchangePointsResultStructure
StopPointGroup
groupStopPointStructure
StopPlaceRefStructure
StopPlaceRef
StopPlaceGroup
groupStopPlaceStructure
StopAttributesGroup
groupTopographicPlaceRefStructure
TopographicPlaceRef
TopographicPlaceStructure
PointOfInterestRefStructure
PointOfInterestRef
PointOfInterestStructure
PointOfInterestCategoryStructure
PointOfInterestAdditionalInformationStructure
CategoryKeyValueType
OsmTagStructure
PointOfInterestFilterStructure
AddressRefStructure
AddressRef
AddressDetailGroup
groupAddressStructure
PlaceStructure
PlaceRefStructure
LocationProblemStructure
ExchangePointsProblemStructure
StopEventRequestGroup
groupStopEventParamStructure
StopEventDataFilterGroup
groupStopEventPolicyGroup
groupStopEventContentFilterGroup
groupStopEventResponseGroup
groupStopEventResultStructure
StopEventStructure
CallAtNearStopStructure
StopEventProblemStructure
TripInfoRequestGroup
groupTripInfoParamStructure
TripInfoPolicyGroup
groupTripInfoContentFilterGroup
groupTripInfoResponseGroup
groupTripInfoResultStructure
TripInfoProblemStructure
TripRequestGroup
groupTripParamStructure
TripDataFilterGroup
groupTripPolicyGroup
groupTripMobilityFilterGroup
groupTripContentFilterGroup
groupOptimisationMethodList
NotViaStructure
NoChangeAtStructure
TariffzoneFilterStructure
TripResponseGroup
groupTripResultStructure
TripSummaryStructure
TripStructure
TripLegStructure
TimedLegStructure
TransferLegStructure
ContinuousLegStructure
LegBoardStructure
LegAlightStructure
LegIntermediateStructure
PathGuidanceStructure
PathGuidanceSectionStructure
FollowStructure
TransferDurationGroup
groupPathLinkStructure
PathLinkEndStructure
MultiPointTripRequestGroup
groupMultiPointTripParamStructure
MultiPointTripPolicyGroup
groupMultiPointTripResponseGroup
groupMultiPointTripResultStructure
MultiPointWaitTimeGroup
groupTripStatusGroup
groupTripRefineRequestGroup
groupTripRefineParamStructure
TripRefineResponseGroup
groupTripProblemStructure
TripRequestGroup
groupTripParamStructure
TripDataFilterGroup
groupTripPolicyGroup
groupTripMobilityFilterGroup
groupTripContentFilterGroup
groupOptimisationMethodList
NotViaStructure
NoChangeAtStructure
TariffzoneFilterStructure
TripResponseGroup
groupTripResultStructure
TripSummaryStructure
TripStructure
LegStructure
TimedLegStructure
TransferLegStructure
ContinuousLegStructure
LegBoardStructure
LegAlightStructure
LegIntermediateStructure
PathGuidanceStructure
PathGuidanceSectionStructure
FollowStructure
TransferDurationGroup
groupPathLinkStructure
PathLinkEndStructure
MultiPointTripRequestGroup
groupMultiPointTripParamStructure
MultiPointTripPolicyGroup
groupMultiPointTripResponseGroup
groupMultiPointTripResultStructure
MultiPointWaitTimeGroup
groupTripStatusGroup
groupTripRefineRequestGroup
groupTripRefineParamStructure
TripRefineResponseGroup
groupTripProblemStructure
ServiceViaPointStructure
ProductCategoryStructure
TripViaStructure
ScheduledJourneyGroup
groupServiceGroup
groupServiceOriginGroup
groupServiceDestinationGroup
groupRouteDescriptionGroup
groupDatedJourneyGroup
groupPrivateServiceGroup
groupDatedJourneyStructure
TripPlaceStructure
TimeWindowGroup
groupServiceTimeGroup
groupEstimatedTimeBandGroup
groupServiceArrivalStructure
ServiceDepartureStructure
CallAtStopStructure
StopCallStatusGroup
groupServiceStatusGroup
groupContinuousServiceStructure
VehiclePositionStructure
PlaceContextStructure
NumberOfResultsGroup
groupBaseTripPolicyGroup
groupBaseTripMobilityFilterGroup
groupBaseTripContentFilterGroup
groupLegAttributeStructure
LegTrackStructure
TrackSectionStructure
AvailabilityRequestGroup
groupBookingPTLegStructure
BookingUserStructure
ProvisionedCallAtPlaceStructure
MinMaxTimeBandGroup
groupPassengerProfileGroup
groupPassengerRequirementsGroup
groupDriverAssistanceGroup
groupAvailabilityResponseGroup
groupAvailabilityResultStructure
BookableTicketAndServiceInformationGroup
groupBookableServiceItemStructure
AvailabilityProblemStructure
ProblemDetailGroup
groupPrivateCodeStructure
LinearShapeStructure
AreaStructure
ParticipantRef
OperatorRef
OperatorRefs_RelStructure
OperatorFilterStructure
ProductCategoryRefStructure
ProductCategoryRef
LineDirectionFilterStructure
JourneyRefStructure
JourneyRef
DatedJourneyRefGroup
groupTimedVehicleRefGroup
groupVehicleFilterStructure
SharingServiceUsageGroup
groupSharingServiceStructure
OwnerRefStructure
OwnerRef
OperatingDayRefStructure
OperatingDayRef
OperatingDaysStructure
OperatingDaysGroup
groupWeekdayTimePeriodStructure
GeneralAttributeStructure
SustainabilityGroup
groupStopFareRequestStructure
| Sub-request: stop-related fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | →siri:StopPointRef | |||
| 0:1 | xs:date | Date for which to retrieve Fare information. |
StaticFareRequestStructure
| General Fare information. May depend on date. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:date | Date for which to retrieve Fare information. | ||
0:* | Reference to a FareProduct. |
TripFareRequestStructure
| Structure of a Single Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:1 | +Trip | A complete trip from origin to destination |
MultiTripFareRequestStructure
| Structure of a Multi Trip Fare Request. | ||||
The element contains only one element: | |||||
| 1:* | +Trip | Multiple complete trips from multiple origins and multiple destination |
FareResponseGroup
group
| |||||
FareResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | Fare result choice element. |
FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | ID of this result. | ||
| 0:* | Problems related to this FARE result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Static Fare information. | ||
c |
| -1:1 | Stop-related Fare information. | ||
d |
| -1:* | Fare and FareProducts for a given trip. |
StopFareResultStructure
| Stop-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | One or more lists of Fare zones that belong to a Fare authority/area. | |||
| 0:1 | xs:anyType |
StaticFareResultStructure
| General Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information. | |||
| 0:* | URL to information page on the web. | |||
| 0:1 | xs:anyType |
TripFareProductReferenceStructure
| Element that connects FareProducts to trips. A TripFareProduct is a FAREPRODUCT covering a part or the whole of a TRIP from boarding the first public transport vehicle to alighting from the last public transport vehicle (corresponds to a package of PREASSIGNED FARE PRODUCTs) | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a FareProduct. | ||||
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid from" tripLeg. If missing, then valid from the first leg. | ||
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid to" tripLeg. If missing, then valid to the last leg. |
MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | Non-empty list of trip references in the corresponding MultiTripFareRequestStructure | |||
| 0:* | Zero, one or more FareProducts that are valid for the referenced trips / part of trips. | |||
| 0:1 | The set of passed zones. | |||
| 0:* | URL to Fare information pages on the web. |
FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | ID of this result. | ||
| 0:* | Problems related to this FARE result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Static Fare information. | ||
c |
| -1:1 | Stop-related Fare information. | ||
d |
| -1:* | Fare and FareProducts for a given trip. |
StopFareResultStructure
| Stop-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | One or more lists of Fare zones that belong to a Fare authority/area. | |||
| 0:1 | xs:anyType |
StaticFareResultStructure
| General Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information. | |||
| 0:* | URL to information page on the web. | |||
| 0:1 | xs:anyType |
TripFareProductReferenceStructure
| Element that connects FareProducts to trips. A TripFareProduct is a FAREPRODUCT covering a part or the whole of a TRIP from boarding the first public transport vehicle to alighting from the last public transport vehicle (corresponds to a package of PREASSIGNED FARE PRODUCTs) | ||||
The element contains a sequence of the following elements: | |||||
1:1 | Reference to a FareProduct. | ||||
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid from" LEG. If missing, then valid from the first LEG. | ||
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip. | ||
| 0:1 | xs:NMTOKEN | Identifies the "valid to" LEG. If missing, then valid to the last LEG. |
MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | Non-empty list of trip references in the corresponding MultiTripFareRequestStructure | |||
| 0:* | Zero, one or more FareProducts that are valid for the referenced trips / part of trips. | |||
| 0:1 | The set of passed zones. | |||
| 0:* | URL to Fare information pages on the web. |
| public | authorisedPublic | staff | other | Allowed values for Booking Access. |
| callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none | Allowed values for Flexible Booking method. |
| xs:normalizedString | Allowed values for Booking Process UIC 7037 Code list. |
| any | information | reservations | lostProperty | publicRelations | complaints | emergency | other | Allowed values for CONTACT role. |
| xs:normalizedString | Email address type a@b. |
| xs:NMTOKEN | Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority. |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| FARE_OUTOFAREA | FARE_JOURNEYNOTPERMITTED | FARE_ADDITIONALCHARGES | FARE_ADDITIONALTICKETS | FARE_ROUTENOTFEASIBLE | FARE_ALREADYCOVERED | FARE_DATEOUTOFRANGE | FARE_STOPPOINTUNKNOWN | FARE_OTHER | Types of problems that may be returned in responses to FARE requests. |
| xs:NMTOKEN | Identifier of a FareProduct |
| xs:normalizedString | Allowed values for Group Booking. |
| Adult | Child | Senior | Youth | Disabled | [a simplified and specialised view of USER PROFILE in TM and NeTEx] classification of passengers by age or other factors that may determine the fare they will need to pay. |
| xs:decimal | A percentage value between 0 and 100 |
| xs:normalizedString | Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc. |
| xs:normalizedString | Allowed values for Purchase Moment. |
| xs:normalizedString | Allowed values for Purchase when. |
| xs:NMTOKEN | Identifier of a fare zone. |
| all | first | second | third | business | economy | classes of travel available on a particular service which will affect the price to be paid |
FareAuthorityRefStructure
| Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs). |
FareAuthorityRef
| Reference to a Fare Authority. |
FareAuthorityGroup
group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||
FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
FareProductBooking |
| 0:* | URL to information for this FareProduct | ||
| 0:* | URL to buy the FareProduct online. | |||
| 0:* |
TripLegRangeGroup
group
| Range of trip legs (from - to) for which a Fare result (ticket) is valid. | ||||
TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. |
TripFareResultStructure
| Structure of a Single Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
TripLegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" trip leg. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" trip leg. | ||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One ore more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. |
FarePassengerStructure
| [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | |
b |
| -1:1 | sequence of all passenger categories, for which this FareProduct is valid | ||
| 0:1 | A list of ENTITLEMENT PRODUCTs. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it. | ||
b |
| -1:1 | Fare zones for which the passenger already has a valid FareProduct. |
FareDataFilterGroup
group
| Data filter group for Fare request. |
LegRangeGroup
group
| Range of LEGs (from - to) for which a Fare result (ticket) is valid. | ||||
LegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" LEG. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" LEG. |
TripFareResultStructure
| Structure of a Single Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | Result-specific error messages. | |||
LegRange |
| 1:1 | xs:NMTOKEN | Identifies the "valid from" LEG. | |
| 1:1 | xs:NMTOKEN | Identifies the "valid to" LEG. | ||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One ore more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. |
FarePassengerStructure
| [a specialised form of USER PROFILE in TM and NeTEx] attributes of a passenger that influence the price to be paid by that passenger for a FARE PRODUCT. | ||||
The element contains a sequence of the following elements: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | |
b |
| -1:1 | sequence of all passenger categories, for which this FareProduct is valid | ||
| 0:1 | A list of ENTITLEMENT PRODUCTs. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it. | ||
b |
| -1:1 | Fare zones for which the passenger already has a valid FareProduct. |
FareDataFilterGroup
group
| Data filter group for Fare request. | ||||
FareDataFilter |
| 0:* | Fare authority for which to retrieve Fare information. | ||
| 0:* | sequence of all passenger categories, for which this FareProduct is valid | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). |
OptimisationMethodList
| List of OptimisationMethods. The order of precedence - if used at all - is high to low. In single criteria optimisers the optimisation methods may be used in parallel and not truly used to score the results. | ||||
The element contains only one element: | |||||
| 1:* |
NotViaStructure
| NNot-via restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs that the TRIP is not allowed to pass through | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place |
NoChangeAtStructure
| no-change-at restrictions for a TRIP, i.e. SCHEDULED STOP POINTs or STOP PLACEs at which no TRANSFER is allowed within a TRIP. | ||||
The element contains only one element: | |||||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | →siri:StopPointRef | ||
b | -1:1 | Reference to a Stop Place |
TariffzoneFilterStructure
| |||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:boolean | Whether to include or exclude given tariff zones in the list from the search. Default is to include. | ||
| 1:1 |
TripResponseGroup
group
| Trip response structure. | ||||
TripResponse |
| 0:1 | Context to hold trip response objects that occur frequently. | ||
| 0:* | The trip results found by the server. |
TripResultStructure
| Structure for a single trip result and associated problems. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip result for referencing purposes. Unique within trip response. | ||
| 0:* | Problems related to this Trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* |
TripSummaryStructure
| Structure for trip overview information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip. | ||
| 0:1 | xs:dateTime | Departure time at origin. | ||
| 0:1 | xs:dateTime | Arrival time at destination. | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport trip legs. | ||
| 0:1 | siri:DistanceType | Trip distance. |
TripResultStructure
| Structure for a single trip result and associated problems. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip result for referencing purposes. Unique within trip response. | ||
| 0:* | Problems related to this Trip result. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | +Trip | Detailed information on trip. | |
b |
| -1:1 | Summary on trip. Only if requestor set TripSummaryOnly in request. | ||
| 0:* |
TripSummaryStructure
| Structure for trip overview information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 0:1 | Describes the origin situation of this trip. | |||
| 0:1 | Describes the arrival situation of this trip. | |||
| 0:1 | xs:duration | Overall duration of the trip. | ||
| 0:1 | xs:dateTime | Departure time at origin. | ||
| 0:1 | xs:dateTime | Arrival time at destination. | ||
| 0:1 | xs:nonNegativeInteger | Number of public transport trip legs. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType |
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 1:1 | xs:duration | Overall duration of the trip. | ||
| 1:1 | xs:dateTime | Departure time at origin. | ||
| 1:1 | xs:dateTime | Arrival time at destination. | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
| 1:* | Legs of the trip | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType |
TripStructure
| [an extended form of PT TRIP in TM and NeTEx as it also includes the initial and final access legs to and from public transport] whole journey from passenger origin to passenger destination in one or more trip LEGs | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip for referencing purposes. Unique within trip response. | ||
| 1:1 | xs:duration | Overall duration of the trip. | ||
| 1:1 | xs:dateTime | Departure time at origin. | ||
| 1:1 | xs:dateTime | Arrival time at destination. | ||
| 1:1 | xs:nonNegativeInteger | Number of interchanges. | ||
| 0:1 | siri:DistanceType | Trip distance. | ||
| 1:* | +Leg | Legs of the trip | ||
OperatingDays |
| 0:1 | Bit string definition of operating days. | ||
| 0:1 | Textual description of the operation days, e.g. "monday to friday" or "not on holidays". | |||
| 0:1 | xs:boolean | Whether this trip deviates from the planned service pattern. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip is delayed. Default is false. | ||
| 0:1 | xs:boolean | Whether this trip cannot be used, due to operational delays and impossible transfers. Default is false. | ||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType |
TripLegStructure
| a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange) | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip leg. Unique within trip result. | ||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | |||
b |
| -1:1 | |||
c |
| -1:1 | |||
| 0:* | Information about the feasibility of the TRIP, in particular with respect to the access features used. | |||
| 0:1 | A list of references to SITUATIONs. | |||
| 0:1 | xs:anyType |
LegStructure
| a single stage of a TRIP that is made without change of MODE or service (ie: between each interchange) | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | xs:NMTOKEN | Id of this trip leg. Unique within trip result. | ||
| 0:1 | siri:ParticipantRefStructure | [equivalent of PARTICIPANT in SIRI] IT system that is participating in a communication with other participant(s) | ||
Then, the element contains one of the following elements: | |||||
a |
| -1:1 | |||
b |
| -1:1 | |||
c |
| -1:1 | |||
Sustainability |
| 0:1 | |||
The element contains a sequence of the following elements: | |||||
| 1:1 | Kilogram by person and by kilometer of CO2 emission. | |||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:positiveInteger | The attribute is valid from the stop point with this sequence number within the leg. If missing it is valid from the beginning of the leg. | ||
| 0:1 | xs:positiveInteger | The attribute is valid to the stop point (inclusively) with this sequence number within the leg. If missing it is valid to the end of the leg. |
LegTrackStructure
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | LINK PROJECTION on the infrastructure network of the trip leg section together with time information. |
TrackSectionStructure
| LINK PROJECTION on the infrastructure network of the TRIP LEG together with time information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track. | |||
| 0:1 | End place of this track. | |||
| 0:1 | An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. | |||
| 0:1 | xs:string | Name of the road this track section is attached to. | ||
| 0:1 | xs:duration | Duration the passenger needs to travel through this track section. | ||
| 0:1 | siri:DistanceType | Length of this track section. | ||
| 0:1 | xs:anyType |
LegTrackStructure
| The LINK PROJECTION of a Leg onto the topography of the route being followed. | ||||
The element contains only one element: | |||||
| 1:* | LINK PROJECTION on the infrastructure network of the leg section together with time information. |
TrackSectionStructure
| LINK PROJECTION on the infrastructure network of the LEG together with time information | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | Start place of this track. | |||
| 0:1 | End place of this track. | |||
| 0:1 | An oriented correspondence from one LINK of a source layer, onto an entity in a target layer: e.g. LINK SEQUENCE. | |||
| 0:1 | xs:string | Name of the road this track section is attached to. | ||
| 0:1 | xs:duration | Duration the passenger needs to travel through this track section. | ||
| 0:1 | siri:DistanceType | Length of this track section. | ||
| 0:1 | xs:anyType |
| AVAILIBILITY_NOSERIVCEFOUND | AVAILABILITY_LOCATIONUNSERVED | AVAILABILITY_LOCATIONUNKNOWN | AVAILABILITY_OUTSIDERULES | AVAILABILITY_SERVICEDISRUPTED | AVAILABILITY_UNAVAILABLE | AVAILABILITY_OTHER | Types of problems that may be returned in responses to AVAILABILITY requests. |
| wheelchair | motorisedWheelchair | foldableWheelchair | walkingFrame | pram | heavyLuggage | childSeatTakenAlong | childSeatSupplied | babyCarrierTakenAlong | babyCarrierSupplied | seatBoosterSupplied | bicycle | guideDog | dog | boardingAssistance | alightingAssistance | onboardAssistance | unassistedMinorAssistance | Types of bookable service items. |
AvailabilityRequestGroup
group
| Availability request. Used to check the availability of a MOBILITY SERVICE, a VEHICLE, SERVICE JOURNEY or SINGLE JOURNEY. Be aware that usually after the response arrives, the rest of the TRIP must be recalculated. As especially pickup and setdown locations may have shifted from where they were in the previously calculated TRIP. | ||||
The element contains one of the following elements: | |||||
AvailabilityRequest | a |
| -1:1 | Definition of the journey leg to be covered by public transport. Other mobility services can be added later. | |
| 1:* | Passenger(s) for whom the service needs to be booked, one MobilityUser per passenger. |