From 208d9ca9958746ef2e1bd74d0a7ad2c95cac1e98 Mon Sep 17 00:00:00 2001 From: Travis CI User Date: Wed, 28 Sep 2022 08:17:48 +0000 Subject: [PATCH] Travis CI update [skip ci] --- OJP/OJP_FareSupport.xsd | 1 - docs/generated/OJP.html | 12 ++++++------ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index 4892d47cd..1ffa84e5a 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -1,5 +1,4 @@ - OJP/OJP_FareSupport.xsd - Supporting definitions for fare information on passenger trips diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index ce43c80f6..89f53710d 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -18,7 +18,7 @@

OJP - Open API for distributed Journey 2. OJP/OJP_Common.xsd - Supporting definitions of common structures
  • 3. OJP/OJP_FacilitySupport.xsd - Supporting definitions for facilities containing wrappers for SIRI
  • 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_JourneySupport.xsd - Supporting definitions for journeys on public transport vehicles
  • 7. OJP/OJP_ModesSupport.xsd - Supporting definitions for the classification of modes of transport
  • 8. OJP/OJP_Places.xsd - Request and response definitions for place information
    • @@ -71,13 +71,13 @@

    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.

    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:

    ErrorMessage

    0:*

    +ErrorMessage

    Result-specific error messages.

    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 a traveller card (f.e. BahnCard50, BahnCard50First etc.).

    FareAuthorityCodeType

    xs:NMTOKEN

    Identifier of a Fare Authority.

    FareProductCodeType

    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.

    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

    VatRateEnumeration

    no | full | half | mixed | unknown

    Enumeration of Value Added Tax rates.

    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

    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.

    FareProductCodeType

    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.

    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

    VatRateEnumeration

    no | full | half | mixed | unknown

    Enumeration of Value Added Tax rates.

    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

    FareProductCode

    Reference to a FareProduct.

    5.13. The toplevel element FareProductRef

    FareProductRef

    +FareProductRef

    Reference to a FareProduct.

    5.14. The complex type EntitlementProductRefStructure

    EntitlementProductRefStructure

    EntitlementProductCode

    Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

    5.15. The toplevel element EntitlementProductRef

    EntitlementProductRef

    +EntitlementProductRef

    Reference to a a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc).

    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

    FareProductCode

    Unique Id of the 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 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

    FareProductCode

    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

    @@ -87,7 +87,7 @@

    OJP - Open API for distributed Journey

    - + @@ -104,7 +104,7 @@

    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

    FareProductCode

    Unique Id of the 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 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/

    VatRate

    0:1

    VatRate

    Rate of value added tax. Default is unknown.

    FareProductValidity

    TravelClass

    0:1

    TypeOfFareClass

    Travel class for which the FareProduct is valid.

    RequiredCard

    0:*

    +EntitlementProductRef

    One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

    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.

    ValidityDuration

    0:1

    xs:duration

    Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

    ValidityDurationText

    0:1

    +InternationalText

    Textual description of maximum validity duration.

    VatRate

    0:1

    VatRate

    Rate of value added tax. Default is unknown.

    5.18. The FareProductValidityGroup group

    - + @@ -120,7 +120,7 @@

    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:*

    +EntitlementProductRef

    One or more traveller cards that are needed for purchase of this FareProduct. In most cases traveller cards offer discounts, f.e. BahnCard50 of Deutsche Bahn.

    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.

    ValidityDuration

    0:1

    xs:duration

    Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation).

    ValidityDurationText

    0:1

    +InternationalText

    Textual description of maximum validity duration.

    5.21. The complex type TripFareResultStructure

    -

    TripFareResultStructure

    Structure of a Single Trip Fare Request result

    The element contains a sequence of the following elements:

    ErrorMessage

    0:*

    +ErrorMessage

    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

    EntitlementProduct

    0:*

    +EntitlementProductRef

    [a specific form of TRAVEL DOCUMENT in TM and NeTEx] a precondition to access a service or to purchase a FARE PRODUCT issued by an organisation that may not be a PT operator (eg: military card, concessionary card, etc)

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

    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