Schemas
AccessRightInProduct
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Fare frame ref.
Fare frame ref.
version^([A-Z]{3}):([A-Za-z… · requiredAccess right in product version.
accessNumberThe actual access number
accessNumberIsLimitedFlag indicating if access number is limited
changedChanged datetime.
compatibleWithVersionRefCompatible with version.
createdCreated datetime.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
isFirstInSequenceWhether element is first in sequence
isLastInSequenceWhether element is last in sequence
limitedAccessNumberFlag indicating whether this rights gives an unlimited number of accesses or not
maximumAccessMaximum number of times use of this element may occur in a given trip
minimumAccessMinimum number of times use of this element must occur in a given trip
modificationModification status.
Name represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
orderOfElementThe actual order in the sequence
statusAccess right in product status.
AccessRightInProductInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Fare frame ref.
Fare frame ref.
accessNumberThe actual access number
accessNumberIsLimitedFlag indicating if access number is limited
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
isFirstInSequenceWhether element is first in sequence
isLastInSequenceWhether element is last in sequence
maximumAccessMaximum number of times use of this element may occur in a given trip
minimumAccessMinimum number of times use of this element must occur in a given trip
Name represented in different languages. Language codes are ISO-639.
orderOfElementThe actual order in the sequence
Accommodation
changedChanged datetime
createdCreated datetime
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
accommodationFacilityAccommodation facility.
nuisanceFacilitiesList of nuisance facilities
AmountOfPriceUnitProduct
amountAmount. Must be greater than 0.
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
productTypeAmountOfPriceUnitProductType.
statusStatus
AccessRightParameterAssignmentRefs.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
changedChanged datetime.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef
A summary of a condition.
createdCreated datetime.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
privateCodePrivateCode.
A classification of FARE PRODUCTs.
ValidityCondition.
version^([A-Z]{3}):([A-Za-z…Version
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
AreaValidity
changedChanged datetime.
createdCreated datetime.
id^([A-Z]{3}):([A-Za-z… · requiredId.
minimumZonesForAreaValidityMinimum no. of zones for area validity.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
groupOfTariffZoneRefGroup of tariff zone
typeOfAreaValidityType of area validity
AvailabilityCondition
changedChanged datetime
createdCreated datetime
Fare frame ref.
fromDateFromDate datetime.
id^([A-Z]{3}):([A-Za-z… · requiredId.
isAvailableIs available
modificationModification status
nameOfClassName of class
statusStatus
toDatetoDate datetime.
version^([A-Z]{3}):([A-Za-z… · requiredAvailabilityCondition version.
availableDay Type references.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Time band references.
CappedDiscountRight
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
ValidityCondition.
vatGroupRegisterVatGroupRegister.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
Capping rules.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Prices.
privateCodePrivateCode.
A classification of FARE PRODUCTs.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
CappedDiscountRightInsert
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
operatorRefOperatorRef.
organisation^([A-Z]{3}):([A-Za-z… · requiredOrganisation.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
Capping rules.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
ConditionSummary.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Prices.
privateCodePrivateCode.
Fare frame ref.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
vatGroupRegisterVatGroupRegister.
CappingRule
activeComparisonOperatorVariantDeprecated: this parameter will be ignored.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
Access Right Parameter assignments.
cappingPeriodPeriod over which capping applies.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Reference to fare table.
Name represented in different languages. Language codes are ISO-639.
Fare frame ref.
Prices for the fare.
Fare frame ref.
Validity conditions.
CappingRuleInsert
Access Right Parameter assignment references.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored.
Fare frame ref.
FareTableRef.
id^([A-Z]{3}):([A-Za-z… · requiredId.
UserProfile Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
cappingPeriodPeriod over which capping applies.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare prices.
Fare frame ref.
Cell
changedChanged datetime.
createdCreated datetime.
A description of the price and factor for a set fare
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
References to for example geographical interval and UserProfile
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
channelGroupRefChannel group reference
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description.
Name.
CellInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
Fare frame ref.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description.
Fare frame ref.
References to for example geographical interval and UserProfile
versionChargingMoment
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusCharging moment status.
version^([A-Z]{3}):([A-Za-z… · requiredCharging moment version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
ChargingMomentInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredCharging moment version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
ChargingPolicy
changedChargingPolicy changed datetime.
createdChargingPolicy create datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status
nameOfClassName of class.
statusStatus
billingPolicyTravelBillingPolicy is optional. No default value
creditPolicyTravel credit policy enum is optional. No default value
ChargingPolicy description in different languages. Language codes are ISO-639
expireAfterPeriodExpire after period. Represented as a string formatted according to ISO-8601
ChargingPolicy name in different languages. Language codes are ISO-639.
paymentGracePeriodPayment grace period. Represented as a string formatted according to ISO-8601
typeOfUsageParametertype of UsageParameter.
version^([A-Z]{3}):([A-Za-z…Version
CompanionProfile
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the companion profile.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
discountBasisBasis for discount.
References to fare tables that provide prices or discounts for the companion profile.
Fare frame ref.
Fare frame ref.
maximumNumberOfPersonsMaximum number of allowed companions.
minimumNumberOfPersonsMinimum number of allowed companions.
The name of the companion profile represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare prices for the companion profile.
typeOfUsageParametertypeOfUsageParameter.
userProfileIdA user profile defining a category of people eligible to be a companion.
Fare frame ref.
Validity conditions for the companion profile.
ticketingThe type of way that tickets are issued to the group.
CompanionProfileInject
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the companion profile.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
discountBasisBasis for discount.
Fare frame ref.
maximumNumberOfPersonsMaximum number of allowed companions.
minimumNumberOfPersonsMinimum number of allowed companions.
The name of the companion profile represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare prices for the companion profile.
typeOfUsageParametertypeOfUsageParameter.
userProfileIdA user profile defining a category of people eligible to be a companion.
Fare frame ref.
ticketingThe type of way that tickets are issued to the group.
ConditionSummary
id^([A-Z]{3}):([A-Za-z… · requiredId.
isExchangeableWhether the ticket is exchangeable.
isRefundableWhether the ticket is refundable.
ConditionSummaryInsert
id^([A-Z]{3}):([A-Za-z… · requiredId.
isExchangeableWhether the ticket is exchangeable.
isRefundableWhether the ticket is refundable.
DayType
changedChanged datetime.
createdCreated datetime.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
dayLengthDay length. Represented as a string formatted according to ISO-8601
Description of day type
durationAfterPropertiesOfDayDuration after properties of day. Represented as a string formatted according to ISO-8601
durationBeforePropertiesOfDayDuration before properties of day. Represented as a string formatted according to ISO-8601
earliestTimeEarliest time.
Name of day type
Properties of day
Time band references.
DistanceMatrixElement
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
nameOfClassName of class.
version^([A-Z]{3}):([A-Za-z… · requiredDistanceMatrixElement version.
Description represented in different languages. Language codes are ISO-639.
distanceDistance.
endFareZoneRefEnd fare zone reference.
endScheduledStopPointIdEnd scheduled stop point netexId.
References to fare tables that provide prices or discounts for the user profile.
groupIdGroup id.
Fare frame ref.
inverseAllowedInverse is allowed.
isDirectIs a direct route.
Fare frame ref.
DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.
Fare prices for the user profile.
relativeRankingRelative ranking.
startFareZoneRefStart fare zone reference.
startScheduledStopPointIdStart scheduled stop point netexId.
tariffIdTariff id.
Fare frame ref.
Validity conditions for the user profile.
endTariffZoneIdEnd tariff zone reference. This field is deprecated, please use the field endFareZoneRef.
startTariffZoneIdStart tariff zone reference. This field is deprecated, please use the field startFareZoneRef.
DistanceMatrixElementInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredDistanceMatrixElement version.
Description represented in different languages. Language codes are ISO-639.
distanceDistance.
endFareZoneRefEnd fare zone reference.
endScheduledStopPointIdEnd scheduled stop point netexId.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
inverseAllowedInverse is allowed.
isDirectIs a direct route.
Fare frame ref.
DistanceMatrixElement Name represented in different languages. Language codes are ISO-639.
Fare prices for the user profile.
relativeRankingRelative ranking.
startFareZoneRefStart fare zone reference.
startScheduledStopPointIdStart scheduled stop point netexId.
Fare frame ref.
Validity conditions for the user profile.
endTariffZoneIdEnd tariff zone reference. This field is deprecated, please use the field endFareZoneRef
startTariffZoneIdStart tariff zone reference. This field is deprecated, please use the field startFareZoneRef
DistributionAssignment
allDistributionChannelsRefFlag for distribution in all channels.
changedChanged datetime.
createdCreated datetime.
distributionRightsDistribution rights.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
Fare frame ref.
paymentMethodsPayment methods.
Fare frame ref.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
allOrganisationRefFlag for all organisations.
allowedInChannelFlag for allowed in channel.
allowedInCountryFlag for allowed in country.
anyCountryRefFlag for allowed in any country.
compatibleWithVersionRefCompatibleWithVersionRef.
countryRefCountry reference.
derivedFromVersionRefDerived from version.
Description.
Fare frame ref.
distributionChannelTypeType of distribution channel.
finalCarrierFlag for final carrier.
Fare frame ref.
Fare frame ref.
Fare frame ref.
initialCarrierFlag for initial carrier.
mandatoryProductFlag for mandatory product.
Name.
requiresRegistrationFlag for requires registration.
responsibilitySetRefResponsibility set reference.
restrictedToChannelFlag for restricted to channel.
Fare frame ref.
ticketingServicesTicketing services.
topographicPlaceRefTopographical place reference.
transitCarrierFlag for transit carrier.
DistributionAssignmentInsert
allDistributionChannelsRefFlag for distribution in all channels.
distributionRightsDistribution rights.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
Fare frame ref.
Fare frame ref.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
distributionChannelRefDistribution channel Ref.
Fare frame ref.
Fare frame ref.
paymentMethodsPayment methods.
EntitlementConstraint
nameOfClassName of class
classOfUseConstraintClass of use constraint
destinationConstraintDestination constraint
directionConstraintDirection constraint
Fare scheduled stop points which entitlement applies
journeyConstraintJourney constraint
operatorConstraintOperator constraint
originConstraintOrigin constraint
periodConstraintPeriod constraint
routeConstraintRoute constraint
specificProfilesSpecific user profiles which entitlement applies
tariffZoneConstraintTariff zone constraint
typeOfProductCategoryConstraintType of product category constraint
typeOfTravelDocumentConstraintType of travel document constraint
userConstraintUser constraint
EntitlementGiven
changedChanged datetime
createdCreated datetime
Description represented in different languages. Language codes are ISO-639
entitlementTypeEntitlement type
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
The name of the entitlement given represented in different languages. Language codes are ISO-639
nameOfClassName of class
Prices for the entitlement given.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.
minimumQualificationPeriodMinimum qualification period
Fare frame ref.
EntitlementProduct
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
idId.
modificationModification status.
nameOfClassName of class.
statusStatus.
ValidityCondition.
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Description.
FareTableRef.
Fare frame ref.
Name.
organisationOrganisation who own the product.
privateCodePrivateCode.
A classification of FARE PRODUCTs.
versionVersion.
EntitlementRequired
changedChanged datetime
createdCreated datetime
Description represented in different languages. Language codes are ISO-639
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
The name of the entitlement required represented in different languages. Language codes are ISO-639
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Entitlement Constraint. Only allowed values for now is periodConstraint.SAME_PERIOD and tariffZoneConstraint.SAME_AS_ORIGIN_OR_DESTINATION. Trying to write other values will give HTTP.BAD_REQUEST.
minimumQualificationPeriodMinimum period that required product shall be held in order to be eligible. Represented as a string formatted according to ISO-8601
organisationIdOrganisation related to the userProfile
Fare prices for the entitlement required.
serviceAccessRightNetexIdReference to the serviceAccessRight required.
typeOfUsageParametertypeOfUsageParameter.
Pricing rule reference.
Exchanging
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusExchanging status.
allowedAllowed.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationDuration to start of period before (negative) or after (positive) the trigger point resellWhen (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) or that ticket may be exchanged or refunded.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationDuration to end of period before (negative) or after ( positive) the trigger point (i.e. either BEFORE_START_OF_VALIDITY_PERIOD or BEFORE_FIRST_USE) that ticket may be exchanged or refunded.
References for associated fare tables.
hasFeeHas fee.
A LimitingRule
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the exchanging rule.
refundBasisBasis on which refund is made. See allowed values below.
resellWhenEvent marking when the exchangeable status of the ticket changes.
specifiedProductsReference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'
toFareClassFare class to which can be exchanged.
unusedTicketsOnlyUnused tickets only.
version^([A-Z]{3}):([A-Za-z…Exchanging version.
ExchangingAlternatives
Exchanging alternatives for this element.
Describes the ID and version of an element.
ExchangingInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
allowedAllowed.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationExchangeable from duration.
exchangeableToType of exchange allowed.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
hasFeeHas fee.
numberOfExchangesAllowedNumber of times a ticket may be exchanged.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Fare prices.
refundBasisBasis on which refund is made. See allowed values below.
resellWhenEvent marking when the exchangeable status of the ticket changes.
specifiedProductsReference to the product IDs where exchanging to is allowed. Only use this in combination with 'exchangeableTo.SPECIFIED_PRODUCTS'.
toFareClassFare class to which can be exchanged.
unusedTicketsOnlyUnused tickets only.
FareDayType
changedChanged datetime.
createdCreated datetime.
Description of fare day type
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
Name of fare day type
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
dayLengthDay length. Represented as a string formatted according to ISO-8601
durationAfterPropertiesOfDayDuration after properties of day. Represented as a string formatted according to ISO-8601
durationBeforePropertiesOfDayDuration before properties of day. Represented as a string formatted according to ISO-8601
earliestTimeEarliest time.
Properties of day
Time band references.
FareFrame
changedChanged datetime.
createdCreated datetime.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredFareFrame version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
FareProducts.
FareStructureElements.
FareFrame Name represented in different languages. Language codes are ISO-639.
SalesPackages.
transportOrganisationNameOfClassTransport organisation nameOfClass.
transportOrganisationNetexIdTransport organisation netexId.
transportOrganisationRefTransport organisation ref.
transportOrganisationVersionTransport organisation version.
typeOfFareFrameNetexIdType of fareFrame netexId.
Fare frame ref.
typeOfFareFrameVersionType of fareFrame version.
ValidableElements.
Validity condition.
vehicleModeVehicle mode.
FarePointInPattern
id^([A-Z]{3}):([A-Za-z… · requiredId
Fare frame ref.
modificationModification status
orderOfElementOrder of element
pointRefPoint Ref
statusStatus
versionVersion, will be a versioned child of journey pattern
changedChanged datetime
createdCreated datetime
nameOfClassName of class
Validity Conditions.
FarePrice
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
idId.
modificationModification status.
nameOfClassName of class.
statusStatus.
amountAmount
canBeCumulativecanBeCumulative.
compatibleWithVersionRefCompatible with version.
currencyCurrency.
derivedFromVersionRefDerived from version.
discountPercentageUseddiscountPercentageUsed.
isAllowedisAllowed.
A LimitingRule
Name.
rankingRanking.
Fare frame ref.
vatRegisterGroupvatRegisterGroup.
versionVersion.
A description of how prices are rounded post calculation
FarePriceInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
amountAmount.
canBeCumulativecanBeCumulative.
compatibleWithVersionRefCompatible with version.
currencyCurrency.
derivedFromVersionRefDerived from version.
discountPercentageUseddiscountPercentageUsed.
isAllowedisAllowed.
A LimitingRule
rankingRanking.
Fare frame ref.
vatRegisterGroupvatRegisterGroup.
versionRounding.
FarePriceUpdate
amountAmount in the currency selected at create operation
discountPercentageUsedDiscount in percentageUsed
FareProduct
AccessRightParameterAssignments.
AccessRightsInProduct.
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
ValidityCondition.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the fareProduct
privateCodePrivateCode.
A classification of FARE PRODUCTs.
version^([A-Z]{3}):([A-Za-z…Version
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
FareQuotaFactor
changedChanged datetime
createdCreated datetime
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredFareQuotaFactor version. Versioned child of FSE,trying to set other versions will be ignored
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
numberOfUnitsThe number of units.
Fare prices for the fare quota factor.
Gives a sequence of conditions for validity.
valueThe value of fare quota factor.
FareScheduledStopPoint
stopPlaceNetexId^([A-Z]{3}):([A-Za-z…Stop place Netex Id
stopPointNetexId^([A-Z]{3}):([A-Za-z…Stop point Netex Id
FareSection
changedChanged datetime
createdCreated datetime
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Description
Fare frame ref.
Fare frame ref.
Name
Fare frame ref.
FareStructureElement
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fare table reference
geographical interval sequence
geographical structure factor refs
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
Access Right Parameter assignments.
quality structure factor refs
statusStatus.
ValidityConditions sequence.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
A LimitingRule
Name.
organisationIdOrganisation related to the userProfile
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Distance matrix elements should be connected by a 'geographical structure factor'
FareStructureElementInSequence
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fareStructureElementIdFare structure element ref
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
nameOfClassName of class.
version^([A-Z]{3}):([A-Za-z… · requiredFare structure element in sequence version.
Description.
isFirstInSequenceGives information if this sequence first or not
isLastInSequenceGives information if this sequence last or not
limitedAccessNumberFlag indicating whether this rights gives an unlimited number of accesses or not
Name.
orderOfElementAccess quality structure factor refs
accessNumberDeprecated: Historically always null and omitted from the response. In NeTEx this field is optional and has been superseded by the minimumAccess/maximumAccess range (introduced in NeTEx v1.1), available on AccessRightInProduct.
FareStructureElementInSequenceInsert
Fare frame ref.
fareStructureElementIdFare structure element id
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
accessNumberThe actual access number
Description.
isFirstInSequenceWhether element is first in sequence
isLastInSequenceWhether element is last in sequence
limitedAccessNumberFlag indicating whether this rights gives an unlimited number of accesses or not
Name.
orderOfElementAccess quality structure factor refs
FareStructureElementInsert
Fare frame ref.
fare table reference
geographical interval sequence
id^([A-Z]{3}):([A-Za-z… · requiredId.
Access Right Parameter assignments.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description.
geographicalStructureFactorIdGeographical structure factor id
Name.
Fare prices.
tariffBasisTariff basis.
version^([A-Z]{3}):([A-Za-z…Version.
Field is deprecated. Use 'geographical structure factor' instead to connect 'distance matrix elements' to 'fare structure element'
FareStructureElementPageWrapper
Fare structure elements for the given page
requestedPageNumberNumber of the requested page. In case state is lost
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
FareTable
Cell
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
FarePrice.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description.
endDateEndDate.
Name.
organisationIdOrganisation related to the fare table
startDateStartDate.
FareTableInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
Cell
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description.
endDateEndDate.
FarePrice.
startDateStartDate.
Fare frame ref.
FareTablePageWrapper
Fare Tables for the given page
requestedPageNumberNumber of the requested page. In case state is lost
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
FrequencyOfUse
changedFrequency of use changed datetime.
createdFrequency of use created datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredFrequency of use version.
Description represented in different languages. Language codes are ISO-639.
frequencyOfUseTypeFrequency of use type.
maximalFrequencyMaximal frequency given for this frequency of use.
minimalFrequencyMinimal frequency given for this frequency of use.
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the refunding rule.
FrequencyOfUseInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredFrequency of use version.
Description represented in different languages. Language codes are ISO-639.
References for associated fare tables.
frequencyOfUseTypeFrequency of use type.
maximalFrequencyMaximal frequency given for this frequency of use.
minimalFrequencyMinimal frequency given for this frequency of use.
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the frequency of use.
FulfilmentMethod
changedChanged datetime.
createdCreated datetime.
Description represented in different languages. Language codes are ISO-639
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
The name of the fulfilment method represented in different languages. Language codes are ISO-639
Prices for the fulfilment method.
statusStatus.
Reference to TYPEs OF TRAVEL DOCUMENT allowed by method.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
fulfilmentMethodTypeType of fulfilment method.
modificationModification status.
nameOfClassName of class.
requiresBookingReferenceWhether collecting ticket requires booking reference.
requiresCardWhether collecting ticket requires credit card used to purchase.
GeneralGroupOfEntities
changedChanged datetime
createdCreated datetime
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Member refs.
modificationModification status
nameOfClassName of class
nameOfMemberClassName of member class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredGeneralGroupOfEntities version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
GeneralGroupOfEntities Description represented in different languages. Language codes are ISO-639.
GeneralGroupOfEntities Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Validity conditions for the general group of entities.
GenericParameterAssignment
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
Fare frame ref.
Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Name represented in different languages. Language codes are ISO-639.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters
GenericParameterAssignmentInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
canIgnoreInOfferingIndicates whether gpa leaf node is supposed to be ignored when generating offer.
chargingBasisTypeChargingBasisType.
comparisonOperatorVariantDeprecated: this parameter is ignored.
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Fare frame ref.
Fare frame ref.
Includes genericParameterAssignments.
includesGroupingTypeIncludes grouping type.
limitationGroupingTypeLimitation grouping type.
Limitations as UsageParameters.
Fare frame ref.
requiredElementsRequired elements.
requiredInContextRequired in context.
requiredTypeRequired type.
Fare frame ref.
Temporal Validity parameter.
A classification of Access Right Assignments.
Fare frame ref.
validityParameterAssignmentTypeValidity parameter assignment type.
validityParameterGroupingTypeValidity parameter grouping type.
validityParameterSetSelectionTypeValidity parameter set operator.
Validity parameters as scoping validity parameters
GeographicalInterval
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
endGeographicalValueendGeographicalValue.
Reference to fare table.
intervalTypeintervalType.
A LimitingRule
modificationModification status.
nameOfClassName of class.
numberOfUnitsnumberOfUnits.
Prices for the fare.
startGeographicalValuestartGeographicalValue.
validityConditions.
GeographicalIntervalInsert
Fare frame ref.
Reference to fare table.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Prices for the fare.
endGeographicalValueEndGeographicalValue.
intervalTypeIntervalType.
numberOfUnitsNumberOfUnits.
startGeographicalValueStartGeographicalValue.
version^([A-Z]{3}):([A-Za-z…Version.
GeographicalStructureFactor
changedChanged datetime
createdCreated datetime
Description represented in different languages. Language codes are ISO-639
Distance matrix elements
Fare frame ref.
Geographical intervals
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
The name of the geographical structure factor represented in different languages. Language codes are ISO-639
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
geographicalUnitRefGeographical unit ref
GroupOfDistanceMatrixElements
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
membersIdDistanceMatrixElements within the group.
nameOfClassName of class.
version^([A-Z]{3}):([A-Za-z… · requiredGroupOfDistanceMatrixElements version.
Description represented in different languages. Language codes are ISO-639.
fareFrameIdFare frame id.
GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.
tariffIdTariff id.
Validity conditions for the user profile.
GroupOfDistanceMatrixElementsInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
membersDistanceMatrixElements within the group.
version^([A-Z]{3}):([A-Za-z… · requiredGroupOfDistanceMatrixElements version.
Description represented in different languages. Language codes are ISO-639.
fareFrameIdFare frame id.
GroupOfDistanceMatrixElements name represented in different languages. Language codes are ISO-639.
tariffIdTariff id.
Validity conditions for the user profile.
GroupOfTimeBands
changedChanged datetime.
createdCreated datetime.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Members.
modificationModification status.
nameOfClassName of class.
statusStatus.
ValidityConditions sequence.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
version^([A-Z]{3}):([A-Za-z…Version.
GroupTicket
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the group ticket.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
Fare frame ref.
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the group ticket.
GroupTicketInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredThe version of the group ticket.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
groupDiscountBasisgroupDiscountBasis
jointCheckInjointCheckIn
maximumNumberOfPersonsmaximumNumberOfPersons
minimumNumberOfPersonsminimumNumberOfPersons
The name of the group ticket represented in different languages. Language codes are ISO-639.
Fare prices for the group ticket.
pricingBasisPrice basis
ticketingThe type of way that tickets are issued to the group.
typeOfUsageParametertypeOfUsageParameter.
IdAndVersion
id^([A-Z]{3}):([A-Za-z… · requiredID of the element.
version^([A-Z]{3}):([A-Za-z… · requiredVersion of the element.
Interchanging
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description.
fromModeVehicle fromMode.
maximumNumberOfChangesMaximumNumberOfChanges.
maximumTimeToMakeATransferMaximumTimeToMakeATransfer
Name.
toModeVehicle toMode.
Fare frame ref.
InterchangingInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
Description.
fromModeVehicle fromMode.
maximumNumberOfChangesMaximumNumberOfChanges.
maximumTimeToMakeATransferMaximumTimeToMakeATransfer
toModeVehicle toMode.
Fare frame ref.
version^([A-Z]{3}):([A-Za-z…Version.
JourneyPattern
changedChanged datetime
createdCreated datetime
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
Description
Fare points in pattern. Versioned child of JourneyPattern
Name
LimitingRule
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
canBeCumulativeCanBeCumulative.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description.
discountAsPercentageDiscountAsPercentage.
discountAsValueDiscountAsValue.
maximumPriceMaximumPrice.
maximumPriceAsPercentageMaximumPriceAsPercentage.
minimumLimitPriceMinimumLimitPrice.
minimumPriceMinimumPrice.
Name.
version^([A-Z]{3}):([A-Za-z…Version.
LuggageAllowance
changedChanged datetime
createdCreated datetime
Description represented in different languages. Language codes are ISO-639
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
The name of the luggage allowance represented in different languages. Language codes are ISO-639
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
baggageTypeBaggage Type
baggageUseTypeBaggage Use Type
luggageAllowanceTypeLuggage Allowance Type
luggageChargingBasisLuggage Charging Basis
organisationIdOrganisation related to the userProfile
Prices for the luggage allowance.
Metadata
createdCreated datetime
id^([A-Z]{3}):([A-Za-z… · requiredId
nameOfClassName of class.
responsibleResponsible
version^([A-Z]{3}):([A-Za-z… · requiredVersion
externalReferenceNameExternal reference name
externalReferenceUrlExternal reference URL
noteNote
MininmalVersionInfo
changedChanged datetime.
createdCreated datetime.
idId.
nameOfClassName of class.
statusStatus
versionVersion
endDateEndDate
Name represented in different languages. Language codes are ISO-639.
startDateStartDate
NameAndDescription
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
OnboardStay
changedChanged datetime
createdCreated datetime
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
durationDuration.
fareClassFareclass.
permissionBoardingPermissionEnum.
ParameterPossibilitiesRequest
Fare structure elements the user wants to retrieve the parameter alternatives for.
Preassigned products the user wants to retrieve the parameter alternatives for.
Sales packages the user wants to retrieve the parameter alternatives for.
Validable elements the user wants to retrieve the parameter alternatives for.
PenaltyPolicy
changedChanged
createdCreated
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
Fare frame ref.
A LimitingRule
Fare frame ref.
minimumTimeBeforeReentryMinimumTimeBeforeReentry
Name.
paymentMethodPaymentMethod
penaltyActionPenaltyAction
penaltyPolicyTypePenaltyPolicyType
Prices in different currencies for the penalty policy.
sameStationReentryPolicyTypeSameStationReentryPolicyType
typeOfUsageParameterReftypeOfUsageParameter.
PenaltyPolicyAlternatives
Penalty policy alternatives for this element.
Describes the ID and version of an element.
PeriodTicketInfo
id^([A-Z]{3}):([A-Za-z… · requiredId.
Limitations as UsageParameters.
operatorRefOperatorRef.
organisationOrganisation who own the product.
version^([A-Z]{3}):([A-Za-z…Version.
PreassignedFareProduct
AccessRightParameterAssignments.
AccessRightsInProduct.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
ValidityCondition.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
Name.
operatorRefOperatorRef.
organisationOrganisation who own the product.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
A classification of FARE PRODUCTs.
version^([A-Z]{3}):([A-Za-z…Version.
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
PreassignedFareProductInsert
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
operatorRef^([A-Z]{3}):([A-Za-z… · requiredOperatorRef.
organisationOrganisation.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
ConditionSummary.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare prices.
privateCodePrivateCode.
productTypeThe type of fare product.
Fare frame ref.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
PreassignedFareProductPageWrapper
Preassigned fare products for the given page
requestedPageNumberRequested page number.
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
PricingParameterSet
changedChanged datetime.
compatibleWithVersionRefCompatible with version.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
Different rules that is common for the operator
ProblemDetail
detailinstancestatustitletypeProductTreeExplained
Description of the root element represented in different languages. Language codes are ISO-639
Description of the explained element represented in different languages. Language codes are ISO-639
Name of the explained element represented in different languages. Language codes are ISO-639
id^([A-Z]{3}):([A-Za-z… · requiredId for root component/element
Name of the root element represented in different languages. Language codes are ISO-639
severitySeverity of the explained event. 'error' drops the tree; 'warning' is published alongside the tree
version^([A-Z]{3}):([A-Za-z… · requiredVersion for root component/element
explainedElementIdThe netexId of the explained element
explainedElementNameOfClassThe nameOfClass of the explained element
explainedElementVersionThe version of the explained element
Translated messages explaining the failure
nameOfClassnameOfClass
originalErrorMessageThe original error message thrown
reasonReason for failed tree
PropertyOfDay
countryRefReference to country for holiday. ISO 3166-1
nameName of property of day
dayOfYearDay of year
daysOfWeekDays of week
descriptionDescription of the property of day
holidayTypesHoliday types
monthOfYearMonth of year
PurchaseWindow
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time to purchase.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
purchaseWhenWhen to purchase.
PurchaseWindowInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
PurchaseWindow Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredPurchaseWindow version.
Description represented in different languages. Language codes are ISO-639.
latestTimeLatest time.
A LimitingRule
maxmumPeriodBeforeDepartureMaximum period before departure.
minimumPeriodBeforeDepartureMinimum period before departure.
purchaseWhenWhen to purchase.
Refunding
allowedAllowed.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusRefunding status.
version^([A-Z]{3}):([A-Za-z… · requiredRefunding version.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationExchangeable from duration.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
hasFeeHas fee.
limitingRulePricing rule.
Fare frame ref.
Name represented in different languages. Language codes are ISO-639.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the refunding rule.
refundBasisBasis on which refund is made. See allowed values below.
refundTypeRefund type.
resellWhenEvent marking when the refundable status of the ticket changes.
unusedTicketsOnlyUnused tickets only.
RefundingAlternatives
Describes the ID and version of an element.
Refunding alternatives for this element.
RefundingInsert
allowedAllowed.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
canChangeClassWhether user can change class.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationExchangeable from duration.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
hasFeeHas fee.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Prices in different currencies for the refunding rule.
refundBasisBasis on which refund is made. See allowed values below.
refundTypeRefund type.
resellWhenEvent marking when the refundable status of the ticket changes.
unusedTicketsOnlyUnused tickets only.
Replacing
changedChanged datetime
createdCreated datetime
Fare frame ref.
References for associated fare table.
idId.
modificationModification status
nameOfClassName of class
statusStatus
versionThe version of the replacing.
allowedAllowed.
canChangeClassWhether user can change class.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
exchangeableFromAnyTimeCan be exchanged or refunded from any point after purchase.
exchangeableFromDurationExchangeable from duration.
exchangeableUntilAnyTimeCan be exchanged or refunded until any point after purchase.
exchangeableUntilDurationExchangeable until duration.
hasFeeHas fee.
Name represented in different languages. Language codes are ISO-639.
onlyAtCertainDistributionPointsWhether distribution is restricted to certain points.
Fare prices for the replacing.
refundBasisBasis on which refund is made. See allowed values below.
resellWhenEvent marking when the exchangeable status of the ticket changes.
typeOfUsageParametertypeOfUsageParameter.
unusedTicketsOnlyUnused tickets only.
Gives a sequence of conditions for validity.
Reserving
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusReserving status.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
A LimitingRule
Fare frame ref.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reserving rule.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.
ReservingInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredReserving version.
Description represented in different languages. Language codes are ISO-639.
feeBasisFee basis.
maximumNumberToReserveMaximum amount to reserve.
minimumNumberToReserveMinimum amount to reserve.
mustReserveWholeCompartmentMust reserve whole compartment
Prices for the reserving.
reservationChargeTypeType of charge for reservation.
reservingRequirementsRequirements for reservation.
typeOfUsageParameterType of usage parameter for the reservation.
Reverting
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
idId.
modificationModification status.
nameOfClassName of class.
statusReverting status.
versionReverting version.
allowedAfterControlSpecifies if revert is allowed after control.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References for associated fare tables.
maximumTimeAfterUseMaximum time after use Represented as a string formatted according to ISO-8601
minimumTimeAfterUseMinimum time after use. Represented as a string formatted according to ISO-8601
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the reverting rule.
Fare frame ref.
typeOfUsageParametertypeOfUsageParameter.
RoundTrip
changedChanged datetime.
createdCreated datetime.
doubleSingleFareDouble single fare
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
isRequiredIs required.
modificationModification status.
nameOfClassName of class.
shortTripShort trip
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredRoundTrip version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the round trip.
Fare frame ref.
RoundTrip Name represented in different languages. Language codes are ISO-639.
Fare prices for the round trip.
requiredtripTypeType of round trip
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the round trip.
RoundTripInsert
doubleSingleFareDouble single fare
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
isRequiredIs required.
Round trip Name represented in different languages. Language codes are ISO-639.
shortTripShort trip
version^([A-Z]{3}):([A-Za-z… · requiredRound trip version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the round trip.
Fare frame ref.
Fare prices for the round trip.
requiredtripTypeType of round trip
typeOfUsageParametertypeOfUsageParameter.
Validity conditions for the round trip.
Rounding
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
roundingMethodType of rounding.
statusRounding status.
version^([A-Z]{3}):([A-Za-z… · requiredRounding version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description.
Name.
roundingModulusAmount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.
RoundingInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
roundingMethodType of rounding.
version^([A-Z]{3}):([A-Za-z… · requiredRounding version.
Description.
Name.
roundingModulusAmount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.
SaleDiscountRight
AccessRightParameterAssignments.
AccessRightsInProduct.
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
Name represented in different languages. Language codes are ISO-639.
nameOfClassName of class.
organisationOrganisation who own the product.
Prices for the sdr.
statusStatus
ValidityCondition.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatibleWithVersionRef
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType.
FareTableRef.
Fare frame ref.
operatorRefOperatorRef.
organisationIdOrganisation related to the userProfile
privateCodePrivateCode.
A classification of FARE PRODUCTs.
Fare frame ref.
validationRequirementsAn optional set of validation requirement enums with the following allowable values: IDENTIFIABLE_CUSTOMER, VERIFIED_DELAY_OR_CANCELLATION, ASSESSMENT_DOCUMENTATION, ORIGINAL_TICKET_REQUIRED
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
SaleDiscountRightPageWrapper
SaleDiscountRights for the given page
requestedPageNumberNumber of the requested page. In case state is lost
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
SalesPackage
Access Right Parameter assignments.
changedSalesPackage changed datetime.
createdSalesPackage create datetime.
Distribution assignments.
Fare frame ref.
References to fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
A LimitingRule
Fare frame ref.
SalesPackage Name.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
version^([A-Z]{3}):([A-Za-z…Version
SalesPackageElement
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References to fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
Description.
Fare frame ref.
A LimitingRule
Fare frame ref.
Name.
Fare frame ref.
Fare frame ref.
SalesPackageElementInsert
Fare frame ref.
References to fare tables.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
compatibleWithVersionRefCompatibleWithVersionRef
derivedFromVersionRefDerived from version.
Description.
Fare frame ref.
A LimitingRule
Fare frame ref.
Fare frame ref.
version^([A-Z]{3}):([A-Za-z…Version
SalesPackageInsert
AccessRightParameterAssignments.
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
UserProfile Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUserProfile version.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables.
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default
SalesPackagePageWrapper
SalesPackages for the given page
requestedPageNumberNumber of the requested page. In case state is lost
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
ScopingValidityParameter
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
authorityRefAuthorityRef.
compatibleWithVersionRefCompatibleWithVersionRef.
derivedFromVersionRefDerived from version.
distributionChannelRefDistribution channel ref.
facilitySetReffacilitySetRef.
fareClassesFareClasses. Enum as string with the following values: FIRST_CLASS, SECOND_CLASS, THIRD_CLASS, ECONOMY_CLASS, BUSINESS_CLASS, TURISTA, PREFERENTE, STANDARD_CLASS, PREMIUM_CLASS, ANY, UNKNOWN
fareSectionRefFare section ref.
fareZoneRefFareZoneRef.
groupOfLinesRefGroup of Lines ref.
groupOfTariffZonesRefGroup of Tariff Zones ref.
lineRefLineRef.
lineTypeLineType.
operatorRefOperator referance.
placeUsePlaceUse
scheduledStopPointRefScheduled stop Point ref.
topographicPlaceRefTopographicPlaceRef
transportSubmodeTransportSubmode.
vehicleModeVehicleModeRef.
tariffZoneRefTariffZoneRef. This field is deprecated, please use the field FareZoneRef.
ScopingValidityParameterInsert
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
authorityRefAuthorityRef.
changedcompatibleWithVersionRefCompatibleWithVersionRef
createdderivedFromVersionRefDerived from version.
distributionChannelRefReference to a DISTRIBUTION CHANNEL to which the ACCESS RIGHT PARAMETER ASSIGNMENTs applies.
facilitySetReffacilitySetRef.
fareClassesFare class list.
fareSectionRefFare section ref.
fareZoneRefFareZoneRef.
groupOfLinesRefGroup of lines ref.
groupOfTariffZonesRefGroup of Tariff Zones ref
lineRefLineRef.
lineTypeLineType.
nameOfClassoperatorRefOperator referance.
placeUsePlaceUse
scheduledStopPointRefScheduled stop Point ref.
topographicPlaceRefTopographicPlaceRef
transportSubmodeTransportSubmode.
vehicleModeVehicleModeRef.
tariffZoneRefTariffZoneRef. This field is deprecated, please use the field FareZoneRef
SecurityPolicy
changedChanged
createdCreated
id^([A-Z]{3}):([A-Za-z… · requiredId
minimumAccountSecurityLevelRequired (minimum) sequrity level of a product. The value is specified as a negative number, 0 is the highest level of security (most secure). In Entur we use three default levels: -50, -120 and -200. We have default implementations of SecurityPolicies for these three levels, and these can be retrieved from the security-policy/defaults endpoint.
modificationModification status.
nameOfClassNameOfClass
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
SeqExplainedMessageResponse
emptytraversableAgainServiceFacilitySet
changedChanged datetime
createdCreated datetime
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
SteppedDuration
initialDurationInitial duration. Represented as a string formatted according to ISO-8601
stepUnitStep unit.
subsequentStepsDurationSubsequent duration. Represented as a string formatted according to ISO-8601
maximumDurationMaximum duration. Represented as a string formatted according to ISO-8601
SupplementProduct
accessRightParameterAssignments.
accessRightParameterAssignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fareProductRef.
Reference to information about the fare.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
organisationOrganisation.
Fare frame ref.
statusSupplement product status.
validityConditions.
vatGroupThe VAT group for the SupplementProduct.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
A summary of a condition.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Name represented in different languages. Language codes are ISO-639.
operatorRefThe reference to the operator.
organisationIdOrganisation related to the userProfile
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
A classification of FARE PRODUCTs.
A classification of FARE PRODUCTs according to the payment method and the account location: pre-payment with cancellation (throw-away), pre-payment with debit on a value card, pre-payment without consumption registration (pass), post-payment etc.
SupplementProductInsert
Fare frame ref.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name.
operatorRef^([A-Z]{3}):([A-Za-z… · requiredOperatorRef.
organisationOrganisation.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
AccessRightParameterAssignments.
AccessRightsInProduct.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
compatibleWithVersionRefCompatible with version.
ConditionSummary.
derivedFromVersionRefDerived from version.
Description.
fareStructureTypeFareStructureType.
FareTableRef.
Fare prices.
privateCodePrivateCode.
supplementProductTypeSupplementProductType.
Fare frame ref.
vatGroupRegisterVatGroupRegister is not optional. Default value is TRANSPORT_AND_TICKETS_VAT
Tariff
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredTariffs version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Tariff Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
returnFareTwiceSinglereturnFareTwiceSingle
tariffBasisTariffBasis.
Fare frame ref.
TariffInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
Tariff Name represented in different languages. Language codes are ISO-639.
Fare frame ref.
version^([A-Z]{3}):([A-Za-z… · requiredTariff version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
returnFareTwiceSinglereturnFareTwiceSingle
tariffBasisTariffBasis.
TemporalValidityParameter
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion
compatibleWithVersionRefCompatibleWithVersionRef
Fare frame ref.
derivedFromVersionRefDerived from version.
A GroupOfTimeband describe during which the assignments applies
A condition of the validity of the priceable object
Fare frame ref.
TemporalValidityParameterInsert
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
changedcreatedFare frame ref.
A GroupOfTimeband describe during which the assignments applies
nameOfClassA condition of the validity of the priceable object
Fare frame ref.
TextInLanguage
langLanguage code.
valueThe text.
Timeband
changedChanged datetime.
createdCreated datetime.
dayOffsetDays offset. This will determine if endTime is x number of days from today. ie. 1 is tomorrow 0 is today.
Description represented in different languages. Language codes are ISO-639
endTimeEnd time.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
The name of the luggage allowance represented in different languages. Language codes are ISO-639
nameOfClassName of class.
startTimeStart time.
statusStatus.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
timeZoneTime zone.
ValidityConditions sequence.
version^([A-Z]{3}):([A-Za-z…Version.
Transferability
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredTransferability version.
canTransferWhether ticket can be transferred to someone else.
Description represented in different languages. Language codes are ISO-639.
References for associated fare tables.
hasTransferFeeWhether there is a charge for making a transfer.
maximumNumberOfNamedUsersWhere a product can be used by a limited number of named users, maximum number of users allowed..
Name represented in different languages. Language codes are ISO-639.
Prices in different currencies for the transferability rule.
TransferabilityAlternatives
Describes the ID and version of an element.
Transferability alternatives for this element.
TypeOfAccessRightAssignment
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusType of access right assignment status.
version^([A-Z]{3}):([A-Za-z… · requiredType of access right assignment version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
TypeOfConcession
changedChanged datetime.
compatibleWithVersionRefCompatible with version.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredTypeOfConcession version.
alternativeNamesAlternative names for the type of concession
derivedFromVersionRefDerived from version.
TypeOfConcession description represented in different languages. Language codes are ISO-639.
infolinkAn URL to more info about the type of concession
TypeOfConcession name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
privateCodeA code to support interoperability with legacy systems
TypeOfConcessionInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
TypeOfConcession name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredTypeOfConcession version.
alternativeNamesAlternative names for the type of concession
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
TypeOfConcession description represented in different languages. Language codes are ISO-639.
infolinkAn URL to more info about the type of concession
privateCodeA code to support interoperability with legacy systems
TypeOfFareProduct
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
nameOfClassName of class.
version^([A-Z]{3}):([A-Za-z… · requiredType of fare product version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
modificationModification status.
Name represented in different languages. Language codes are ISO-639.
statusType of fare product status.
TypeOfFareProductInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
version^([A-Z]{3}):([A-Za-z…Type of fare product version.
TypeOfResponsibilityRole
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusType of responsibility role status.
typeOfResponsibilityRoleType of responsibility role
version^([A-Z]{3}):([A-Za-z… · requiredType of responsibility role version.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
TypeOfUsageParameter
changedChanged datetime.
compatibleWithVersionRefCompatible with version.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
TypeOfUsageParameterInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
Description represented in different languages. Language codes are ISO-639.
Name represented in different languages. Language codes are ISO-639.
UVPForNumberOfZones
authorityIdReference to authority.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
nameOfClassName of class.
numberOfZonesNumber of zones.
statusStatus.
usageValidityPeriodIdReference to usage validity period.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
zoneRangeZone range.
UVPForNumberOfZonesInsert
authorityIdReference to authority.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
numberOfZonesNumber of zones.
usageValidityPeriodIdReference to usage validity period.
version^([A-Z]{3}):([A-Za-z…Version.
zoneRangeZone range.
UsageValidityPeriod
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References to FareTable.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
activationMeansActivation Means. Describes how a product can be activated.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
A LimitingRule
UsageValidityPeriod Name represented in different languages. Language codes are ISO-639.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
Stepped duration.
usageEndUsage end.
usageStartConstraintTypeUsage start constraint.
usageTriggerUsage trigger.
usageValidityTypeUsage validity type.
usageValidityTypesUsage validity type list.
usageEndsUsage ends. This field is deprecated, please use the field usageEnd
UsageValidityPeriodInsert
Fare frame ref.
References to FareTable.
id^([A-Z]{3}):([A-Za-z… · requiredId.
Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredUsageValidityPeriod version.
activationMeansActivation Means. Describes how a product can be activated.
Description represented in different languages. Language codes are ISO-639.
standardDurationStandard duration. Represented as a string formatted according to ISO-8601
Stepped duration.
usageEndUsage end.
usageEndsUsage End list.
usageStartConstraintTypeUsage start constraint.
usageTriggerUsage trigger.
usageValidityTypesUsage validity type list.
UserProfile
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion Profiles in Group Ticket
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
UserProfile Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices for the user profile.
proofOfIdentityproofOfIdentity.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.
UserProfileInsert
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
UserProfile Name represented in different languages. Language codes are ISO-639.
proofOfIdentityproofOfIdentity.
version^([A-Z]{3}):([A-Za-z… · requiredUserProfile version.
baseUserProfileRefThe id of the base user profile which this profile is a specialization of.
Companion profiles describing users who may travel with user.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
References to fare tables that provide prices or discounts for the user profile.
Fare frame ref.
maxAgeMaximum age.
minAgeMinimum age.
Fare prices for the user profile.
typeOfConcessionReftypeOfConcessionRef.
typeOfUsageParametertypeOfUsageParameter.
userTypeUserType.
Validity conditions for the user profile.
companionProfileIdsCompanion profiles describing users who may travel with user.
ValidBetween
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
fromDateFrom Date.
id^([A-Z]{3}):([A-Za-z… · requiredId.
nameOfClassName of class.
statusStatus
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
Description of ValidBetween represented in different languages. Language codes are ISO-639.
Name of ValidBetween represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
toDateTo Date.
List of validityConditions.
ValidBetweenInsert
Fare frame ref.
fromDateFrom Date.
id^([A-Z]{3}):([A-Za-z… · requiredId.
toDateTo Date.
List of validityConditions.
version^([A-Z]{3}):([A-Za-z…Version.
ValidableElement
The references to access right parameter assignments.
changedChanged datetime.
createdCreated datetime.
Fare frame ref.
References for associated fare table.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredValidable element version.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
compatibleWithVersionRefCompatible with version.
derivedFromVersionRefDerived from version.
Description represented in different languages. Language codes are ISO-639.
The fare structure elements in sequence
The reference to the fare divided into a sequence.
Name represented in different languages. Language codes are ISO-639.
organisationIdOrganisation related to the userProfile
Fare prices.
pricingRuleRefPricing rule reference.
Gives a sequence of conditions for validity.
ValidableElementInsert
Description represented in different languages. Language codes are ISO-639.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
ValidableElement Name represented in different languages. Language codes are ISO-639.
version^([A-Z]{3}):([A-Za-z… · requiredValidableElement version.
The references to access right parameter assignments.
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Requirements for area validity.
Fare structure elements in sequence
The reference to the fare divided into a sequence.
References to fare tables that provide prices or discounts for the user profile.
Fare prices.
ValidableElementPageWrapper
Validable elements for the given page
requestedPageNumberNumber of the requested page. In case state is lost
totalNumberOfItemsTotal number of items.
totalNumberOfPagesNumber of pages needed to traverse all items.
ValidityCondition
changedChanged datetime.
createdCreated datetime.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
statusStatus.
version^([A-Z]{3}):([A-Za-z… · requiredVersion.
fromDateFrom Date.
toDateTo Date.
VatRegister
descriptionThe VAT description
idId.
validFromThe time and date from which the VAT is valid
vatGroupVAT group
vatRateThe percentage rate for the VAT
arrivalCountryCodeSpecification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3
countryCodeCountry for which the VAT is valid, based on ISO 3166-1 alfa-3
departureCountryCodeSpecification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3
organisationIdOrganisationId for the organisation who uses this VAT-specification.
validToThe time and date to which the VAT is valid
vatCodeCode for the VAT, used for accounting
Version
changedChanged datetime
createdCreated datetime
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status
nameOfClassName of class
statusStatus
versionTypeVersionType.
descriptionDescription.
endDateEndDate
startDateStartDate
VersionBatchRetrieve
entityIdsentityIds
VersionOfObjectRef
nameOfClassName of class.
ref^([A-Z]{3}):([A-Za-z… · requiredThe netex id reference to the object.
versionVersion.
v2.DistributionAssignment
allDistributionChannelsRefFlag for distribution in all channels.
changedChanged datetime.
createdCreated datetime.
distributionRightsDistribution rights.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
Fare frame ref.
paymentMethodsPayment methods.
Fare frame ref.
statusStatus
versionVersion
allOrganisationRefFlag for all organisations.
allowedInChannelFlag for allowed in channel.
allowedInCountryFlag for allowed in country.
anyCountryRefFlag for allowed in any country.
countryRefCountry reference.
Description represented in different languages. Language codes are ISO-639
Fare frame ref.
distributionChannelTypeType of distribution channel.
finalCarrierFlag for final carrier.
Fare frame ref.
Fare frame ref.
Fare frame ref.
initialCarrierFlag for initial carrier.
mandatoryProductFlag for mandatory product.
The name of the distribution assignment represented in different languages. Language codes are ISO-639
requiresRegistrationFlag for requires registration.
responsibilitySetRefResponsibility set reference.
restrictedToChannelFlag for restricted to channel.
Fare frame ref.
ticketingServicesTicketing services.
topographicPlaceRefTopographical place reference.
transitCarrierFlag for transit carrier.
v2.SalesPackage
changedChanged datetime
createdCreated datetime
Distribution assignments.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId
modificationModification status
nameOfClassName of class
statusStatus
Validity Parameter assignments.
version^([A-Z]{3}):([A-Za-z… · requiredVersion
activeComparisonOperatorVariantDeprecated: this parameter will be ignored
Description
A LimitingRule
Fare frame ref.
Name
organisationIdOrganisation related to the userProfile
Fare prices.
Sales package elements.
vatGroupRegisterVatGroupRegister is optional. No default value
v2.SupplementProduct
changedChanged datetime.
Fare frame ref.
createdCreated datetime.
Fare frame ref.
id^([A-Z]{3}):([A-Za-z… · requiredId.
modificationModification status.
nameOfClassName of class.
operatorRefThe reference to the operator.
organisationRefThe reference to the organisation.
statusSupplement product status.
version^([A-Z]{3}):([A-Za-z… · requiredSupplement product version.
accessRightParameterAssignments.
accessRightParameterAssignments.
activeComparisonOperatorVariantDeprecated: this parameter is ignored.
chargingMomentTypeChargingMomentType. Default value is BEFORE_TRAVEL.
A summary of a condition.
Description represented in different languages. Language codes are ISO-639.
fareStructureTypeFareStructureType
Reference to information about the fare.
Name represented in different languages. Language codes are ISO-639.
Fare prices.
privateCodePrivat code.
supplementProductTypeThe type of supplement product for which the supplement product belongs to.
Fare frame ref.
validityConditions.
vatGroupRegisterThe VAT group for the SupplementProduct.