diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index 6f45e1ee5..aacfec9bf 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -137,45 +137,335 @@ ========================================== Booking ========================================== - + - [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey + Allowed values for CONTACT role. + + + + + + + + + + + + + + + Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc. + + + + + + Email address type a@b. + + + + + + Type for contact details. - + - Name of the booking agency (contractual partner). + Name of contact person. - + + + The email address of the contact. + + + - URL to online booking service. + Contact telephone number. - + - URL to information page. + Contact fax number. - + - Phone number for booking. + The web site address of the contact. + + + + + Further details about contact process. + + + + + + + + Allowed values for Flexible Booking method. + + + + + + + + + + + + + + + + List of values for Flexible Booking values. + + + + + + + + + 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 on boarding transport vehicle. + + + + + Purchase can only be made on boarding 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. + + + + + + + + + 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. + + + + + + + + + Allowed values for Group Booking. + + + + + + + + + + + + List of Group Booking values. + + + + + + + + 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 duration bookings must be completed before trip starts. + 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. + + + + + Note about booking the FLEXIBLE 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. @@ -389,6 +679,11 @@ Structure of a Single Trip Fare Request result + + + Result-specific error messages. + + @@ -463,7 +758,7 @@ - Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS + Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). diff --git a/docs/generated/index.html b/docs/generated/index.html index 8a82db6b6..feb749f90 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -61,7 +61,7 @@

OJP - Open API for distributed Journey 2. OJP/OJP_Requests.xsd - OJP service requests and responses
  • 3. OJP/OJP_RequestSupport.xsd - Supporting definitions for OJP service requests and their responses
  • 4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information
  • -
  • 5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
  • +
  • 5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips
  • 6. OJP/OJP_Lines.xsd - Request and response definitions for information on lines
  • 7. OJP/OJP_Places.xsd - Request and response definitions for place information
  • 8. OJP/OJP_PlaceSupport.xsd - Supporting definitions for place information
  • @@ -336,13 +336,25 @@

    OJP - Open API for distributed Journey FareResponse

    FareResponseContext

    0:1

    +ResponseContext

    Context to hold trip response objects that occur frequently.

    FareResult

    0:*

    +FareResult

    Fare result choice element.

    4.7. The complex type FareResultStructure

    FareResultStructure

    Wrapper element for Fare results.

    The element contains a sequence of the following elements:

    ResultId

    1:1

    xs:NMTOKEN

    ID of this result.

    Problem

    0:*

    +FareProblem

    Problems related to this FARE result.

    Then, the element contains one of the following elements:

    a

    MultiTripFareResult

    -1:*

    +MultiTripFareResult

    Fare and FareProducts for multiple trips.

    b

    StaticFareResult

    -1:1

    +StaticFareResult

    Static Fare information.

    c

    StopFareResult

    -1:1

    +StopFareResult

    Stop-related Fare information.

    d

    TripFareResult

    -1:*

    +TripFareResult

    Fare and FareProducts for a given trip.

    4.8. The complex type StopFareResultStructure

    StopFareResultStructure

    Stop-related Fare information.

    The element contains a sequence of the following elements:

    TariffZoneListInArea

    1:*

    +TariffZoneListInArea

    One or more lists of Fare zones that belong to a Fare authority/area.

    Extension

    0:1

    xs:anyType

    4.9. The complex type StaticFareResultStructure

    StaticFareResultStructure

    General Fare information.

    The element contains a sequence of the following elements:

    FareProduct

    0:*

    +FareProduct

    [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information.

    StaticInfoUrl

    0:*

    +WebLink

    URL to information page on the web.

    Extension

    0:1

    xs:anyType

    4.10. The complex type TripFareProductReferenceStructure

    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:

    →‍FareProductRef

    1:1

    →‍FareProductRef

    Reference to a FareProduct.

    FromTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip.

    FromTripLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid from" tripLeg. If missing, then valid from the first leg.

    ToTripIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip.

    ToTripLegIdRef

    0:1

    xs:NMTOKEN

    Identifies the "valid to" tripLeg. If missing, then valid to the last leg.

    4.11. The complex type MultiTripFareResultStructure

    MultiTripFareResultStructure

    Structure of a Multi Trip Fare Request result

    The element contains a sequence of the following elements:

    TripFareProductReference

    1:*

    +TripFareProductReference

    Non-empty list of trip references in the corresponding MultiTripFareRequestStructure

    FareProduct

    0:*

    +FareProduct

    Zero, one or more FareProducts that are valid for the referenced trips / part of trips.

    PassedZones

    0:1

    +TariffZoneListInArea

    The set of passed zones.

    StaticInfoUrl

    0:*

    +WebLink

    URL to Fare information pages on the web.

    -

    5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips

    5.1. Simple type definitions

    EntitlementProductCodeType

    xs:NMTOKEN

    Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority.

    FareAuthorityCodeType

    xs:NMTOKEN

    Identifier of a Fare Authority.

    FareProblemTypeEnumeration

    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.

    FareProductIdType

    xs:NMTOKEN

    Identifier of a FareProduct

    PassengerCategoryEnumeration

    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.

    Percentage

    xs:decimal

    A percentage value between 0 and 100

    TariffZoneCodeType

    xs:NMTOKEN

    Identifier of a fare zone.

    TypeOfFareClassEnumeration

    all | first | second | third | business | economy

    classes of travel available on a particular service which will affect the price to be paid

    5.2. The complex type FareAuthorityRefStructure

    FareAuthorityRefStructure

    FareAuthorityCode

    Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs).

    5.3. The toplevel element FareAuthorityRef

    FareAuthorityRef

    +FareAuthorityRef

    Reference to a Fare Authority.

    5.4. The FareAuthorityGroup group

    +

    5. OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips

    5.1. Simple type definitions

    FareAuthorityGroup

    Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs

    BookingAccessEnumeration

    public | authorisedPublic | staff | other

    Allowed values for Booking Access.

    BookingMethodEnumeration

    callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none

    Allowed values for Flexible Booking method.

    BookingProcessEnumeration

    xs:normalizedString

    Allowed values for Booking Process UIC 7037 Code list.

    ContactTypeEnumeration

    any | information | reservations | lostProperty | publicRelations | complaints | emergency | other

    Allowed values for CONTACT role.

    EmailAddressType

    xs:normalizedString

    Email address type a@b.

    EntitlementProductCodeType

    xs:NMTOKEN

    Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority.

    FareAuthorityCodeType

    xs:NMTOKEN

    Identifier of a Fare Authority.

    FareProblemTypeEnumeration

    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.

    FareProductIdType

    xs:NMTOKEN

    Identifier of a FareProduct

    GroupBookingEnumeration

    xs:normalizedString

    Allowed values for Group Booking.

    PassengerCategoryEnumeration

    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.

    Percentage

    xs:decimal

    A percentage value between 0 and 100

    PhoneType

    xs:normalizedString

    Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc.

    PurchaseMomentEnumeration

    xs:normalizedString

    Allowed values for Purchase Moment.

    PurchaseWhenEnumeration

    xs:normalizedString

    Allowed values for Purchase when.

    TariffZoneCodeType

    xs:NMTOKEN

    Identifier of a fare zone.

    TypeOfFareClassEnumeration

    all | first | second | third | business | economy

    classes of travel available on a particular service which will affect the price to be paid

    5.2. The complex type FareAuthorityRefStructure

    FareAuthorityRefStructure

    FareAuthorityCode

    Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs).

    5.3. The toplevel element FareAuthorityRef

    FareAuthorityRef

    +FareAuthorityRef

    Reference to a Fare Authority.

    5.4. The FareAuthorityGroup group

    FareAuthorityGroup

    Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    5.5. The complex type TariffZoneRefStructure

    TariffZoneRefStructure

    Reference to a fare zone.

    5.6. The toplevel element TariffZoneRef

    TariffZoneRef

    +TariffZoneRef

    Reference to a fare zone.

    5.7. The complex type TariffZoneStructure

    TariffZoneStructure

    [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.

    The element contains a sequence of the following elements:

    →‍TariffZoneRef

    1:1

    →‍TariffZoneRef

    Reference to a fare zone.

    TariffZoneText

    1:1

    xs:string

    Text describing the fare zone. Passengers will recognize the fare zone by this text. Often published on Fare Zone Maps.

    5.8. The complex type TariffZoneListInAreaStructure

    -

    TariffZoneListInAreaStructure

    List of fare zones within the area of a Fare Authority.

    The element contains a sequence of the following elements:

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    TariffZone

    1:*

    +TariffZone

    Fare zone in area.

    5.9. The complex type TariffZoneRefListStructure

    TariffZoneRefListStructure

    List of fare zones references within the area of a Fare Authority.

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    →‍TariffZoneRef

    1:*

    →‍TariffZoneRef

    Reference to a fare zone.

    5.10. The complex type BookingArrangementStructure

    BookingArrangementStructure

    [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey

    The element contains a sequence of the following elements:

    BookingAgencyName

    0:1

    +InternationalText

    Name of the booking agency (contractual partner).

    BookingUrl

    0:1

    +WebLink

    URL to online booking service.

    InfoUrl

    0:1

    +WebLink

    URL to information page.

    PhoneNumber

    0:1

    PhoneNumber

    Phone number for booking.

    MinimumBookingPeriod

    0:1

    xs:duration

    Minimum duration bookings must be completed before trip starts.

    Extension

    0:1

    xs:anyType

    5.11. The complex type BookingArrangementsContainerStructure

    BookingArrangementsContainerStructure

    Container for multiple booking arrangements.

    The element contains a sequence of the following elements:

    BookingArrangement

    1:*

    +BookingArrangement

    [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

    Extension

    0:1

    xs:anyType

    5.12. The complex type FareProductRefStructure

    FareProductRefStructure

    FareProductId

    Reference to a FareProduct.

    5.13. The toplevel element FareProductRef

    FareProductRef

    +FareProductRef

    Reference to a FareProduct.

    5.14. The complex type EntitlementProductListStructure

    EntitlementProductListStructure

    A list of ENTITLEMENT PRODUCTs

    The element contains only one element:

    EntitlementProduct

    1:*

    +EntitlementProduct

    [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".

    5.15. The complex type EntitlementProductStructure

    EntitlementProductStructure

    [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".

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to the fare authority that issued the ENTITLEMENT PRODUCT

    EntitlementProductRef

    1:1

    EntitlementProductCode

    Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...)

    ValidityPeriod

    0:1

    siri:HalfOpenTimestampOutputRangeStructure

    Validity period of the ENTITLEMENT PRODUCT

    EntitlementProductName

    1:1

    xs:string

    Name of the ENTITLEMENT PRODUCT

    5.16. The complex type FareProductStructure

    +

    FareProductStructure

    [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information

    The element contains a sequence of the following elements:

    FareProductId

    1:1

    FareProductId

    Identifier of a FareProduct

    FareProductName

    1:1

    xs:string

    Printable FareProduct name

    TariffZone

    1:*

    +TariffZone

    Fare zone in area.

    5.9. The complex type TariffZoneRefListStructure

    TariffZoneRefListStructure

    List of fare zones references within the area of a Fare Authority.

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    →‍TariffZoneRef

    1:*

    →‍TariffZoneRef

    Reference to a fare zone.

    5.10. The complex type ContactDetailsStructure

    ContactDetailsStructure

    Type for contact details.

    The element contains a sequence of the following elements:

    ContactPerson

    0:1

    +InternationalText

    Name of contact person.

    Email

    0:1

    EmailAddress

    The email address of the contact.

    Phone

    0:1

    Phone

    Contact telephone number.

    Fax

    0:1

    Phone

    Contact fax number.

    Url

    0:1

    +WebLink

    The web site address of the contact.

    FurtherDetails

    0:1

    +InternationalText

    Further details about contact process.

    5.11. The complex type BookingMethodListOfEnumerations

    BookingMethodListOfEnumerations

    List of values for Flexible Booking values.

    The element contains only one element:

    BookingMethod

    1:*

    BookingMethod

    5.12. The complex type PurchaseMomentListOfEnumerations

    PurchaseMomentListOfEnumerations

    List of Purchase Moment values.

    The element contains only one element:

    PurchaeMoment

    1:*

    PurchaseMoment

    5.13. The complex type BookingProcessListOfEnumerations

    BookingProcessListOfEnumerations

    List of Booking Process values.

    The element contains only one element:

    BookingProcess

    1:*

    BookingProcess

    5.14. The complex type GroupBookingListOfEnumerations

    GroupBookingListOfEnumerations

    List of Group Booking values.

    The element contains only one element:

    GroupBooking

    1:*

    GroupBooking

    5.15. The complex type BookingArrangementsStructure

    BookingArrangementsStructure

    Type for BOOKING ARRANGEMENTs modified from NeTEx.

    5.16. The BookingArrangementsGroup group

    + + + + + + + + + + + +

    BookingArrangementsGroup

    Elements for BOOKING ARRANGEMENTs.

    BookingArrangements

    BookingContact

    0:1

    +ContactDetails

    Contact for Booking.

    BookingMethods

    0:1

    +BookingMethodListOf

    Allowed Ways of Making a BOOKING.

    BookingAccess

    0:1

    BookingAccess

    Who can make a booking. Default is public.

    BookWhen

    0:1

    PurchaseWhen

    When Booking can be made.

    BuyWhen

    0:1

    +PurchaseMomentListOf

    When purchase can be made.

    LatestBookingTime

    0:1

    xs:time

    Latest time that booking can be made. The exact meaning must be derived also from BookWhen and MinimumBookingPeriod.

    MinimumBookingPeriod

    0:1

    xs:duration

    Minimum interval in advance of departure day or time that Service may be ordered.

    MaximumBookingPeriod

    0:1

    xs:duration

    Maximum interval in advance of departure day or time that Service may be ordered.

    BookingUrl

    0:1

    +WebLink

    URL for booking.

    BookingNote

    0:1

    +InternationalText

    Note about booking the FLEXIBLE LINE.

    Extension

    0:1

    xs:anyType

    5.17. The complex type BookingArrangementsContainerStructure

    BookingArrangementsContainerStructure

    Container for multiple booking arrangements.

    The element contains a sequence of the following elements:

    BookingArrangement

    1:*

    +BookingArrangements

    [a more generalised form of BOOKING ARRANGEMENTS in TMv6] arrangement for booking any leg or legs of a journey.

    Extension

    0:1

    xs:anyType

    5.18. The complex type FareProductRefStructure

    FareProductRefStructure

    FareProductId

    Reference to a FareProduct.

    5.19. The toplevel element FareProductRef

    FareProductRef

    +FareProductRef

    Reference to a FareProduct.

    5.20. The complex type EntitlementProductListStructure

    EntitlementProductListStructure

    A list of ENTITLEMENT PRODUCTs

    The element contains only one element:

    EntitlementProduct

    1:*

    +EntitlementProduct

    [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".

    5.21. The complex type EntitlementProductStructure

    EntitlementProductStructure

    [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".

    The element contains a sequence of the following elements:

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to the fare authority that issued the ENTITLEMENT PRODUCT

    EntitlementProductRef

    1:1

    EntitlementProductCode

    Identifier of the ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, ...)

    ValidityPeriod

    0:1

    siri:HalfOpenTimestampOutputRangeStructure

    Validity period of the ENTITLEMENT PRODUCT

    EntitlementProductName

    1:1

    xs:string

    Name of the ENTITLEMENT PRODUCT

    5.22. The complex type FareProductStructure

    @@ -362,12 +374,12 @@

    OJP - Open API for distributed Journey

    -

    FareProductStructure

    [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information

    The element contains a sequence of the following elements:

    FareProductId

    1:1

    FareProductId

    Identifier of a FareProduct

    FareProductName

    1:1

    xs:string

    Printable FareProduct name

    FareAuthority

    →‍FareAuthorityRef

    1:1

    →‍FareAuthorityRef

    Reference to a Fare Authority.

    FareAuthorityText

    1:1

    xs:string

    Textual description or name of Fare authority.

    ProtoProduct

    0:1

    xs:boolean

    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/

    FareProductBooking

    InfoUrl

    0:*

    +WebLink

    URL to information for this FareProduct

    SaleUrl

    0:*

    +WebLink

    URL to buy the FareProduct online.

    BookingArrangements

    0:*

    +BookingArrangementsContainer

    Extension

    0:1

    xs:anyType

    5.17. The FareProductPriceGroup group

    +

    FareProductPriceGroup

    [related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased.

    Extension

    0:1

    xs:anyType

    5.23. The FareProductPriceGroup group

    -

    FareProductPriceGroup

    [related to FARE PRODUCT PRICE in TM and NeTEx] price at which a FARE PRODUCT can be purchased.

    FareProductPrice

    Price

    0:1

    xs:decimal

    FareProduct price as decimal number.

    NetPrice

    0:1

    xs:decimal

    Net FareProduct price as decimal number for accounting purposes.

    Currency

    0:1

    xs:NMTOKEN

    iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling

    VatRate

    0:1

    Percentage

    Rate of value added tax.

    5.18. The FareProductValidityGroup group

    +

    FareProductValidityGroup

    conditions of use for a particular FARE PRODUCT.

    5.24. The FareProductValidityGroup group

    @@ -375,25 +387,25 @@

    OJP - Open API for distributed Journey

    -

    FareProductValidityGroup

    conditions of use for a particular FARE PRODUCT.

    FareProductValidity

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which the FareProduct is valid.

    RequiredCard

    0:*

    +EntitlementProduct

    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".

    ValidFor

    0:*

    PassengerCategory

    Sequence of all passenger categories for which this FareProduct is valid.

    ValidityDurationText

    0:1

    +InternationalText

    Textual description of maximum validity duration.

    ValidityTariffZones

    0:*

    +TariffZoneListInArea

    Spatial validity of FareProduct defined as list of fare zones.

    ValidityAreaText

    0:1

    +InternationalText

    Textual description of spatial validity.

    5.19. The FareProductBookingGroup group

    +

    FareProductBookingGroup

    [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.

    5.25. The FareProductBookingGroup group

    -

    FareProductBookingGroup

    [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.

    FareProductBooking

    InfoUrl

    0:*

    +WebLink

    URL to information for this FareProduct

    SaleUrl

    0:*

    +WebLink

    URL to buy the FareProduct online.

    BookingArrangements

    0:*

    +BookingArrangementsContainer

    5.20. The TripLegRangeGroup group

    +

    TripLegRangeGroup

    Range of trip legs (from - to) for which a Fare result (ticket) is valid.

    5.26. The TripLegRangeGroup group

    -

    TripLegRangeGroup

    Range of trip legs (from - to) for which a Fare result (ticket) is valid.

    TripLegRange

    FromTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip leg.

    ToTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip leg.

    5.21. The complex type TripFareResultStructure

    +

    TripFareResultStructure

    Structure of a Single Trip Fare Request result

    The element contains a sequence of the following elements:

    5.27. The complex type TripFareResultStructure

    -

    TripFareResultStructure

    Structure of a Single Trip Fare Request result

    The element contains a sequence of the following elements:

    Problem

    0:*

    +FareProblem

    Result-specific error messages.

    TripLegRange

    FromTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid from" trip leg.

    ToTripLegIdRef

    1:1

    xs:NMTOKEN

    Identifies the "valid to" trip leg.

    PassedZones

    0:1

    +TariffZoneListInArea

    The sequence of passed fare zones.

    FareProduct

    0:*

    +FareProduct

    One ore more FareProducts that are valid for this part of the trip.

    StaticInfoUrl

    0:*

    +WebLink

    URL to static information page on the web.

    5.22. The complex type FarePassengerStructure

    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

    Age

    -1:1

    xs:nonNegativeInteger

    Age of the passenger on the day of travel.

    b

    PassengerCategory

    -1:1

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    EntitlementProducts

    0:1

    +EntitlementProductList

    A list of ENTITLEMENT PRODUCTs.

    Then, the element contains one of the following elements:

    a

    SalesPackageElementRef

    -1:*

    +FareProductRef

    Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.

    b

    ZonesAlreadyPaid

    -1:1

    +TariffZoneRefList

    Fare zones for which the passenger already has a valid FareProduct.

    5.23. The FareDataFilterGroup group

    +

    FareDataFilterGroup

    Data filter group for Fare request.

    PassedZones

    0:1

    +TariffZoneListInArea

    The sequence of passed fare zones.

    FareProduct

    0:*

    +FareProduct

    One ore more FareProducts that are valid for this part of the trip.

    StaticInfoUrl

    0:*

    +WebLink

    URL to static information page on the web.

    5.28. The complex type FarePassengerStructure

    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

    Age

    -1:1

    xs:nonNegativeInteger

    Age of the passenger on the day of travel.

    b

    PassengerCategory

    -1:1

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    EntitlementProducts

    0:1

    +EntitlementProductList

    A list of ENTITLEMENT PRODUCTs.

    Then, the element contains one of the following elements:

    a

    SalesPackageElementRef

    -1:*

    +FareProductRef

    Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it.

    b

    ZonesAlreadyPaid

    -1:1

    +TariffZoneRefList

    Fare zones for which the passenger already has a valid FareProduct.

    5.29. The FareDataFilterGroup group

    - -

    FareDataFilterGroup

    Data filter group for Fare request.

    FareDataFilter

    FareAuthorityFilter

    0:*

    +FareAuthorityRef

    Fare authority for which to retrieve Fare information.

    PassengerCategory

    0:*

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS

    5.24. The complex type FareParamStructure

    + +

    FareParamStructure

    [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.

    The element contains a sequence of the following elements:

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class).

    5.30. The complex type FareParamStructure

    - -

    FareParamStructure

    [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.

    The element contains a sequence of the following elements:

    FareDataFilter

    FareAuthorityFilter

    0:*

    +FareAuthorityRef

    Fare authority for which to retrieve Fare information.

    PassengerCategory

    0:*

    PassengerCategory

    sequence of all passenger categories, for which this FareProduct is valid

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS

    Traveller

    0:*

    +FarePassenger

    Number of travellers that will make the journey and for which Fare information needs to be gathered.

    5.25. The complex type FareProblemStructure

    + +

    FareProblemStructure

    Problem that may be returned in responses to FARE requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    FareProblemType

    Type of the FARE problem.

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class).

    Traveller

    0:*

    +FarePassenger

    Number of travellers that will make the journey and for which Fare information needs to be gathered.

    5.31. The complex type FareProblemStructure

    FareProblemStructure

    Problem that may be returned in responses to FARE requests.

    The element contains a sequence of the following elements:

    Type

    1:1

    FareProblemType

    Type of the FARE problem.

    ProblemDetail

    Title

    0:1

    +InternationalText

    Title of the problem.

    Details

    0:1

    +InternationalText

    Explanation of the problem.

    LogData

    0:1

    xs:string

    Additional log data.