diff --git a/OJP/OJP_Fare.xsd b/OJP/OJP_Fare.xsd index 0b4c0d1bc..4d4886c2f 100644 --- a/OJP/OJP_Fare.xsd +++ b/OJP/OJP_Fare.xsd @@ -124,6 +124,11 @@ Problems related to this FARE result. + + + Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, TravelClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE. + + diff --git a/docs/generated/index.html b/docs/generated/index.html index ca466ea0e..5330ac70f 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -309,7 +309,7 @@

OJP - Open API for distributed Journey

4.2. The complex type StopFareRequestStructure

StopFareRequestStructure

Sub-request: stop-related fare information.

The element contains a sequence of the following elements:

→‍siri:StopPointRef

1:1

→‍siri:StopPointRef

Date

0:1

xs:date

Date for which to retrieve Fare information.

4.3. The complex type StaticFareRequestStructure

StaticFareRequestStructure

General Fare information. May depend on date.

The element contains a sequence of the following elements:

Date

0:1

xs:date

Date for which to retrieve Fare information.

→‍FareProductRef

0:*

→‍FareProductRef

Reference to a FareProduct.

4.4. The complex type TripFareRequestStructure

TripFareRequestStructure

Structure of a Single Trip Fare Request.

The element contains only one element:

Trip

1:1

+Trip

A complete trip from origin to destination

4.5. The complex type MultiTripFareRequestStructure

MultiTripFareRequestStructure

Structure of a Multi Trip Fare Request.

The element contains only one element:

Trip

1:*

+Trip

Multiple complete trips from multiple origins and multiple destination

4.6. The FareResponseGroup group

-

FareResponseGroup

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:

Id

1:1

ObjectId

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.

FromLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid from" LEG. If missing, then valid from the first LEG.

ToTripIdRef

1:1

xs:NMTOKEN

Identifies the "valid to" trip.

ToLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid to" LEG. 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.

+

4.7. The complex type FareResultStructure

FareResultStructure

Wrapper element for Fare results.

The element contains a sequence of the following elements:

Id

1:1

ObjectId

ID of this result.

Problem

0:*

+FareProblem

Problems related to this FARE result.

FareEstimated

0:1

xs:boolean

Whether the fare is only estimated by the service. Estimated can mean different things: For example, the fare may vary depending on age, PassengerCategory, TravelClass, EntitlementProducts. It can also mean that the fare structure used by the service is not entirely accurate or that other factors, such as the time a shared vehicle is used, need to be factored into the price. As a rule, the price should then be given as an approximate and probably lower limit of the actual price. Default is TRUE.

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.

FromLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid from" LEG. If missing, then valid from the first LEG.

ToTripIdRef

1:1

xs:NMTOKEN

Identifies the "valid to" trip.

ToLegIdRef

0:1

xs:NMTOKEN

Identifies the "valid to" LEG. 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

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.