FareResponseContext
0:1
Context to hold trip response objects that occur frequently.
FareResult
0:*
Fare result choice element.
FareResultStructure
| Wrapper element for Fare results. | ||||
The element contains a sequence of the following elements: | |||||
| 1:1 | ID of this result. | |||
| 0:* | Problems related to this FARE result. | |||
| 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 |
| -1:* | Fare and FareProducts for multiple trips. | ||
b |
| -1:1 | Static Fare information. | ||
c |
| -1:1 | Stop-related Fare information. | ||
d |
| -1:* | Fare and FareProducts for a given trip. | ||
StopFareResultStructure
| Stop-related Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | One or more lists of Fare zones that belong to a Fare authority/area. | |||
| 0:1 | xs:anyType | |||
StaticFareResultStructure
| General Fare information. | ||||
The element contains a sequence of the following elements: | |||||
| 0:* | [related to FARE PRODUCT in TM and NeTEx] different FARE PRODUCTs that may be available with related information. | |||
| 0:* | URL to information page on the web. | |||
| 0:1 | xs:anyType | |||
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: | |||||
1:1 | Reference to a FareProduct. | ||||
| 1:1 | Identifies the "valid from" trip. | |||
| 0:1 | Identifies the "valid from" LEG. If missing, then valid from the first LEG. | |||
| 1:1 | Identifies the "valid to" trip. | |||
| 0:1 | Identifies the "valid to" LEG. If missing, then valid to the last LEG. | |||
MultiTripFareResultStructure
| Structure of a Multi Trip Fare Request result | ||||
The element contains a sequence of the following elements: | |||||
| 1:* | Non-empty list of trip references in the corresponding MultiTripFareRequestStructure | |||
| 0:* | Zero, one or more FareProducts that are valid for the referenced trips / part of trips. | |||
| 0:1 | The set of passed zones. | |||
| 0:* | URL to Fare information pages on the web. | |||
| public | authorisedPublic | staff | other | Allowed values for Booking Access. |
| callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none | Allowed values for Flexible Booking method. |
| xs:normalizedString | Allowed values for Booking Process UIC 7037 Code list. |
| any | information | reservations | lostProperty | publicRelations | complaints | emergency | other | Allowed values for CONTACT role. |
| xs:normalizedString | Email address type a@b. |
| xs:NMTOKEN | Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority. |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| 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. |
| xs:NMTOKEN | Identifier of a FareProduct |
| xs:normalizedString | Allowed values for Group Booking. |
| 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. |
| xs:normalizedString | Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc. |
| xs:normalizedString | Allowed values for Purchase Moment. |
| xs:normalizedString | Allowed values for Purchase when. |
| xs:NMTOKEN | Identifier of a fare zone. |
| all | first | second | third | business | economy | classes of travel available on a particular service which will affect the price to be paid |
FareAuthorityRefStructure
| Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs). | ||||
FareAuthorityRef
| Reference to a Fare Authority. | ||||
FareAuthorityGroup group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||
| public | authorisedPublic | staff | other | Allowed values for Booking Access. |
| callDriver | callOffice | online | other | phoneAtStop | text | mobileApp | atOffice | none | Allowed values for Flexible Booking method. |
| xs:normalizedString | Allowed values for Booking Process UIC 7037 Code list. |
| any | information | reservations | lostProperty | publicRelations | complaints | emergency | other | Allowed values for CONTACT role. |
| xs:normalizedString | Email address type a@b. |
| xs:NMTOKEN | Identifier of an ENTITLEMENT PRODUCT (e.g. BahnCard50, BahnCard50First, military card, concessionary card, ...). It is defined by the fare authority. |
| xs:NMTOKEN | Identifier of a Fare Authority. |
| 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. |
| xs:NMTOKEN | Identifier of a FareProduct |
| xs:normalizedString | Allowed values for Group Booking. |
| 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. |
| xs:normalizedString | Type for an International phone number. + Country + MSISDN e.g. +41 675601 etc. |
| xs:normalizedString | Allowed values for Purchase Moment. |
| xs:normalizedString | Allowed values for Purchase when. |
| xs:NMTOKEN | Identifier of a fare zone. |
FareAuthorityRefStructure
| Reference to a Fare Authority ([a specialisation of an ORGANISATION in TMv6] ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs). | ||||
FareAuthorityRef
| Reference to a Fare Authority. | ||||
FareAuthorityGroup group
| Group of attributes for an ORGANISATION which has the RESPONSIBILITY ROLE for the definition of FARE PRODUCTs | ||||
| FareAuthority | 1:1 | Reference to a Fare Authority. | |||
| 1:1 | xs:string | Textual description or name of Fare authority. | ||
TariffZoneRef
| Reference to a fare zone. | ||||
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: | |||||
1:1 | Reference to a fare zone. | ||||
| 1:1 | xs:string | Text describing the fare zone. Passengers will recognize the fare zone by this text. Often published on Fare Zone Maps. | ||
TariffZoneListInAreaStructure
| List of fare zones within the area of a Fare Authority. | ||||
The element contains a sequence of the following elements: | |||||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. | |||
| FareProductValidity |
| 0:1 | Travel class for which the FareProduct is valid. | ||
| FareProductValidity |
| 0:1 | siri:FareClassEnumeration | Fare class for which the FareProduct is valid (Transmodel: CLASS OF USE). | |
| 0:* | 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". | |||
| 0:* | Sequence of all passenger categories for which this FareProduct is valid. | |||
| 0:1 | xs:duration | Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation). | ||
| 0:1 | xs:NMTOKEN | iso 4217 currency code, e.g. EUR for Euro or GBP for Pound Sterling | ||
| 0:1 | Rate of value added tax. | |||
FareProductValidityGroup group
| conditions of use for a particular FARE PRODUCT. | ||||
| FareProductValidity |
| 0:1 | Travel class for which the FareProduct is valid. | ||
| FareProductValidity |
| 0:1 | siri:FareClassEnumeration | Fare class for which the FareProduct is valid (Transmodel: CLASS OF USE). | |
| 0:* | 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". | |||
| 0:* | Sequence of all passenger categories for which this FareProduct is valid. | |||
| 0:1 | xs:duration | Maximum duration of FareProduct validity starting with purchase of ticket or begin of journey (ticket validation). | ||
| 0:1 | The sequence of passed fare zones. | |||
| 0:* | One ore more FareProducts that are valid for this part of the trip. | |||
| 0:* | URL to static information page on the web. | |||
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 |
| -1:1 | xs:nonNegativeInteger | Age of the passenger on the day of travel. | |
b |
| -1:1 | sequence of all passenger categories, for which this FareProduct is valid | ||
| 0:1 | A list of ENTITLEMENT PRODUCTs. | |||
Then, the element contains one of the following elements: | |||||
a |
| -1:* | Id of a FareProduct that the passenger already holds and that may be used for the travel or parts of it. | ||
b |
| -1:1 | Fare zones for which the passenger already has a valid FareProduct. | ||
FareDataFilterGroup group
| Data filter group for Fare request. | ||||
| FareDataFilter |
| 0:* | Fare authority for which to retrieve Fare information. | ||
| 0:* | sequence of all passenger categories, for which this FareProduct is valid | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). | |||
| 0:1 | siri:FareClassEnumeration | Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). Transmodel: CLASS OF USE. | ||
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 |
| 0:* | Fare authority for which to retrieve Fare information. | ||
| 0:* | sequence of all passenger categories, for which this FareProduct is valid | |||
| 0:1 | Travel class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). | |||
| 0:1 | siri:FareClassEnumeration | Fare class for which to retrieve FareProducts. Refers to TYPE OF FARE CLASS (e.g. first class). Transmodel: CLASS OF USE. | ||
| 0:* | Number of travellers that will make the journey and for which Fare information needs to be gathered. | |||
FareProblemType
| FareProblemType (↔ ErrorType) | ||||
| LINEINFORMATION_LINEUNKNOWN | LINEINFORMATION_OTHER | Types of problems that may be returned in responses to LINE INFORMATION requests. |
LineInformationResponseGroup group
| Line Information response group. | ||||
| LineInformationResponse |
| 0:* | |||