diff --git a/OJP/OJP_Fare.xsd b/OJP/OJP_Fare.xsd index 172c1eb4d..f1037cb26 100644 --- a/OJP/OJP_Fare.xsd +++ b/OJP/OJP_Fare.xsd @@ -69,7 +69,11 @@ Date for which to retrieve Fare information. - + + + Reference to a FareProduct. If no FareProductRef is specified the responding system should reply with information about all available fare products. + + diff --git a/docs/generated/index.html b/docs/generated/index.html index 0d28ba901..d280bde0e 100644 --- a/docs/generated/index.html +++ b/docs/generated/index.html @@ -307,7 +307,7 @@

OJP - Open API for distributed Journey

4. OJP/OJP_Fare.xsd - Request and response definitions for general, stop-specific and trip-specific fare information

4.1. The FareRequestGroup group

-

FareRequestGroup

Fare request structure.

The element contains one of the following elements:

FareRequest

a

MultiTripFareRequest

-1:1

+MultiTripFareRequest

A request to calculate aggregated Fare information of multiple single trips

b

StaticFareRequest

-1:1

+StaticFareRequest

A request for general/static Fare information.

c

StopFareRequest

-1:1

+StopFareRequest

A request for stop-related Fare information.

d

TripFareRequest

-1:1

+TripFareRequest

A request to calculate the Fare information of a single trip

Params

0:1

+FareParam

Parameter to filter the response contents.

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

Reference to the stop point.

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 a sequence of the following elements:

TripContext

0:1

+ResponseContext

Context to hold trip related objects that occur frequently. Especially necessary, when the system answering the fare request is not the same as the one that did the trip request.

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 a sequence of the following elements:

TripContext

0:1

+ResponseContext

Context to hold trip related objects that occur frequently.

Trip

1:*

+Trip

Multiple complete trips from multiple origins and multiple destination

4.6. The FareResponseGroup group

+

FareResponseGroup

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

Reference to the stop point.

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. If no FareProductRef is specified the responding system should reply with information about all available fare products.

4.4. The complex type TripFareRequestStructure

TripFareRequestStructure

Structure of a Single Trip Fare Request.

The element contains a sequence of the following elements:

TripContext

0:1

+ResponseContext

Context to hold trip related objects that occur frequently. Especially necessary, when the system answering the fare request is not the same as the one that did the trip request.

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 a sequence of the following elements:

TripContext

0:1

+ResponseContext

Context to hold trip related objects that occur frequently.

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.

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

ObjectId

Identifies the "valid from" trip.

FromLegIdRef

0:1

ObjectId

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

ToTripIdRef

1:1

ObjectId

Identifies the "valid to" trip.

ToLegIdRef

0:1

ObjectId

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.