xsd.2.0.OJP.OJP_FareSupport.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
========================================== Fare Authority ==========================================
A structure for an ordered list of booking notes.
Note about booking the LINE.
Identifier of a Fare Authority.
Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs).
Reference to a Fare Authority.
Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs
Textual description or name of Fare authority.
========================================== Zones ==========================================
Identifier of a fare zone.
Reference to a fare zone.
Reference to a fare zone.
[a more clearly defined equivalent of TARIFF ZONE in TM and NeTEx] A ZONE used to define a zonal fare structure in a zone-counting or zone-matrix system.
Text describing the fare zone. Passengers will recognize the fare zone by this text. Often published on Fare Zone Maps.
List of fare zones within the area of a Fare Authority.
Fare zone in area.
List of fare zones references within the area of a Fare Authority.
========================================== Passengers ==========================================
[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.
========================================== Booking ==========================================
Type for identifier of a BOOKING Object.
Allowed values for CONTACT role.
Type for an International phone number. + Country + MSISDN e.g., +41 675601 etc.
Type for contact details.
Name of contact person.
The email address of the contact.
Contact telephone number.
Contact fax number.
The website address of the contact.
Further details about contact process.
Allowed values for a booking method.
List of values for booking values.
Booking methods.
Allowed values for Booking Access.
Allowed values for Purchase when.
Allowed values for Purchase Moment.
Purchase must be made on reservation in advance of travel.
Purchase can be made in advance of travel.
Purchase can only be made in advance of travel (e.g., for season ticket or advance ticket).
Purchase can be made before boarding transport vehicle.
Purchase must be made before boarding transport vehicle.
Purchase can be made when boarding the transport vehicle.
Purchase can only be made when boarding the transport vehicle.
Purchase can be made after boarding transport vehicle.
Purchase can be made on entering transport system.
Purchase can be made on leaving transport system.
Purchase can only be made on subscription.
Other moment of Purchase.
List of Purchase Moment values.
Possibilities when to pay.
Allowed values for Booking Process UIC 7037 Code list.
Product is not available.
Product cannot be booked.
Product can be booked online internationally.
Product can be booked online nationally.
Product can only be booked by contacting specific authorised retail outlets.
Other booking process.
List of Booking Process values.
Ways how to book (UIC 7037 codes).
Allowed values for Group Booking.
Possibilities and restrictions for group booking.
Group booking policies.
Type for BOOKING ARRANGEMENTs modified from NeTEx.
Elements for BOOKING ARRANGEMENTs.
Contact for Booking.
Allowed ways of making a BOOKING.
Who can make a booking. Default is public.
When Booking can be made.
When purchase can be made.
Latest time that booking can be made. The exact meaning must be derived also from BookWhen and MinimumBookingPeriod.
Minimum interval in advance of departure day or time that Service may be ordered.
Maximum interval in advance of departure day or time that Service may be ordered.
URL for booking.
Notes about booking the LINE.
Container for multiple booking arrangements.
[a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.
========================================== Tickets ==========================================
Identifier of a FareProduct
Reference to a FareProduct.
Reference to a FareProduct.
A list of ENTITLEMENT PRODUCTs
[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g., military card, concessionary card). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn".
Identifier of an ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First, military card, concessionary card). It is defined by the fare authority.
[a specific form of TRAVEL DOCUMENT in TM and NeTEx] Precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (e.g., military card, concessionary card). In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn".
Reference to the fare authority that issued the ENTITLEMENT PRODUCT
Identifier of the ENTITLEMENT PRODUCT (e.g., BahnCard50, BahnCard50First)
Validity period of the ENTITLEMENT PRODUCT
Name of the ENTITLEMENT PRODUCT
[related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information
Identifier of a FareProduct
Printable FareProduct name
Is this product a proto product? Default is false. If true, it should not be shown to the user. In a distributed environment (e.g., EU-Spirit) partial systems may generate incomplete product information (proto product), which has to be processed further and combined with other information before it is a complete fare product and can be shown to the user. See https://eu-spirit.eu/
Remaining offered tickets in this FARE PRODUCT. When absent, the number of remaining tickets is unknown or not limited. In most cases if the FareQuota is zero then the FareProduct is not shown.
[related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased.
FareProduct price as decimal number.
Net FareProduct price as decimal number for accounting purposes.
iso 4217 currency code, e.g., EUR for Euro or GBP for Pound Sterling
Rate of value added tax.
conditions of use for a particular FARE PRODUCT.
Fare class for which the FareProduct is valid (Transmodel: CLASS OF USE).
One or more ENTITLEMENT PRODUCTs required for the purchase of this FareProduct. In most cases, ENTITLEMENT PRODUCTs offer discounts, e.g., the "BahnCard50" of "Deutsche Bahn".
Sequence of all passenger categories for which this FareProduct is valid.
Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).
Textual description of maximum validity duration.
Spatial validity of FareProduct defined as list of fare zones.
Textual description of spatial validity.
[aggregation of DISTRIBUTION CHANNEL and BOOKING ARRANGEMENT in TM and NeTEx] Group of information elements related to information to support the process of booking a FARE PRODUCT.
URL to information for this FareProduct
URL to buy the FareProduct online.
Multiple sets of multiple booking arrangements for different legs of a journey.
========================================== Trip Fare ==========================================
Range of LEGs (from - to) for which a Fare result (ticket) is valid.
Identifies the "valid from" LEG.
Identifies the "valid to" LEG.
Structure of a single TripFareResult. This may cover the whole trip or only the part the service can answer. If only partial answers can be delivered, then this must be indicated with FARE_ADDITIONALTICKETS (as a warning). For a given trip multiple FareResults may need to be combined to get the whole tariff. A typical example may be classic public transport and a sharing leg. Some legs, e.g., TransferLegs and walking ContinuousLeg will never have a price. The service may include them in one of the tickets. If the whole trip is for free, then a TripFareResult with a price of 0 is expected. It is possible to have combined FareResults (e.g., for a bundle) and in addition price each leg individually.
Result-specific error messages.
A ticket may be valid for multiple non-consecutive legs. TransferLegs and ContinuousLegs without a tariff may be either included or ignored. If the tariff depends on not having a ContinuousLeg e.g., with sharing in the middle, then the server must decide, if it wants to provide more than one TripFareResult.
The sequence of passed fare zones.
One or more FareProducts that are valid for this part of the trip.
URL to static information page on the web.
========================================== Fare request parameter ==========================================
[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.
Age of the passenger on the day of travel.
sequence of all passenger categories, for which this FareProduct is valid
A list of ENTITLEMENT PRODUCTs.
Fare zones for which the passenger already has a valid FareProduct.
Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.
Data filter group for Fare request.
Fare authority for which to retrieve Fare information.
sequence of all passenger categories, for which this FareProduct is valid
Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g., first class). Transmodel: CLASS OF USE.
[related to the FARE parameter model in TM and NeTEx] parameters which are used to determine the price to be paid for a FARE PRODUCT by a specific passenger.
Number of travellers that will make the journey and for which Fare information needs to be gathered.
ACCESS MODEs to consider (usually only one). This is only used in very special cases. E.g. for carTransportRail. It indicates if one uses a car, truck, motorcycle or bike. The Access mode may result in no transportation being possible.
========================================== Problems ==========================================
Types of problems that may be returned in responses to FARE requests.
The trip planning has found a route that leaves the area of the fare authority.
The trip planning result suggests a service which is not permitted by the fare authority.
Passengers may be charged additional fees (e.g.: for road tolls or seat reservation).
Additional tickets may be necessary because only parts of the passenger trip could be covered.
Fare calculation is not possible because the suggested trip is not in compliance with the fare regulations, e.g., because of round trips, LEGs that go forth and return or exceed the maximal total trip duration.
The ticket that has been specified in the request is valid for the suggested trip (or parts of it as defined by LegRange).
The fare request cannot be processed because there is no information available for the requested date.
The fare request cannot be processed because the requested stop is unknown.
A problem has occurred that does not have a specific problem type.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy