diff --git a/OJP/OJP_FareSupport.xsd b/OJP/OJP_FareSupport.xsd index 1ffa84e5a..2c7b32b17 100644 --- a/OJP/OJP_FareSupport.xsd +++ b/OJP/OJP_FareSupport.xsd @@ -18,16 +18,13 @@ - + - Enumeration of Value Added Tax rates. + A percentage value between 0 and 100 - - - - - - + + + @@ -300,9 +297,9 @@ iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling - + - Rate of value added tax. Default is unknown. + Rate of value added tax. diff --git a/docs/generated/OJP.html b/docs/generated/OJP.html index a8c5fb616..1146ea39b 100644 --- a/docs/generated/OJP.html +++ b/docs/generated/OJP.html @@ -113,7 +113,7 @@

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

+

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.

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

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

@@ -126,7 +126,7 @@

OJP - Open API for distributed Journey

- + @@ -143,7 +143,7 @@

OJP - Open API for distributed Journey

- +

TariffZoneListInAreaStructure

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

The element contains a sequence of the following elements:

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

VatRate

Rate of value added tax. Default is unknown.

VatRate

0:1

Percentage

Rate of value added tax.

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

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

VatRate

Rate of value added tax. Default is unknown.

VatRate

0:1

Percentage

Rate of value added tax.

5.18. The FareProductValidityGroup group

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