Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: final draft
Note

This page is currently a work in progress and not yet included under final revision, awaiting review approval and inclusion in the Nordic NeTEx Profile

Info

Version

Current version for fares is:   v0.96  (last changed 26 )

Content

Table of Contents
excludeContent


This document is part of the Norwegian NeTEx Profile and describes data elements for the exchange of product and fare related information via the NeTEx format.

Please note the fare/sales-transaction//wiki/spaces/~5570581c85fcb2cac146de902868a8eaf62254/pages/1015382117 parts of the profile describes data object for managing and exchanging fare structures, access rights, fare products, pricing, sales management/services, fare validation and consumption, as well as presentation of fare information to the traveling public. It does not, however, describe network or time-related concepts, such as topology, date objects or departure times, as these are described in their respective profile documents stops, network and timetable.

Components

Fare components

...

Info

A geographical interval specifying access rights for the FARE STRUCTURE ELEMENTs within the range of this interval: “20-5 km”, “4-6 zones”, etc.

Example can be found in the official GitHub-repository for Entur

GeographicalUnit < FareUnit < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Distance

xsd:nonNegativeIntegerpric

0: 1

If distance based unit, length of unit

element

prices

GeographicalUnitPriceRef

0: *

Prices associated with GEOGRAPHICALUNIT

...

Info

A geographical interval specifying access rights for the FARE STRUCTURE ELEMENTs within the range of this interval: “20-5 km”, “4-6 zones”, etc.

Example can be found in the official GitHub-repository for Entur

GeographicalInterval < FareStructureFactor < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

StartGeographicalValue

xsd:decimal

0: 1

Start value for GEOGRAPHICAL INTERVAL

element

EndGeographicalValue

xsd:decimal

0: 1

End value for GEOGRAPHICAL INTERVAL

element

NumberOfUnits

xsd:integer

0: 1

Quantity of units in GEOGRAPHICAL INTERVAL

element

IntervalType

IntervalTypeEnum

0: 1

Classification of interval type

Allowed values:

  • coupon

  • distance

  • section

  • stop

  • tariffZone

  • tariffUnit ( mangler for "takstenhet", dvs ville vært hensiktsmessig med egen type for å modellere TEN/FEN )

element

prices

GeographicalIntervalPriceRef

0: *

Prices for GEOGRAPHICAL INTERVAL

...

GeographicalStructureFactor < FareStructureFactor < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

DistanceMatrixElementRef

DistanceMatrixElementRef

0: 1

Reference to a DISTANCE MATRIX ELEMENT

element

GeographicalIntervalRef

GeographicalIntervalRef

0: 1

Reference to a GEOGRAPHICAL INTERVAL

element

GeographicalUnitRef

GeographicalUnitRef

0: 1

Reference to GEOGRAPHICAL UNIT

element

NumberOfUnits

xsd:integer

0: 1

Quantity of units.

element

AmountFactor

xsd:decimal

0: 1

Arbitrary amount factor associated with Factor

...

Info

A time-based interval specifying access rights for the FARE STRUCTURE ELEMENTs within the range of this interval: “0-1 hours,” “1-3 days”, etc.

Example can be found in the official GitHub-repository for Entur

TimeInterval < FareInterval < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

StartTime

xsd:time

0: 1

Start time of interval

element

EndTime

xsd:time

0: 1

End time of interval

element

Duration

xsd:duration

1: 1

Duration for the TimeInterval

...

Info

The value of a QUALITY INTERVAL or a DISTANCE MATRIX ELEMENT expressed by a QUALITY UNIT.

Example can be found in the official GitHub-repository for Entur

QualityStructureFactor < FareStructureFactor < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Factor

xsd:anyType

0: 1

General Factor amount

element

Value

xsd:anyType

0: 1

Quantitative quality value

element

prices

QualityStructureFactorPrice

0: *

Price for QUALITY STRUCTURE FACTOR

...

Info

A named set of parameters defining a period of travel with a given PRICE, for example; “peak”, “off-peak”, “super off-peak”, etc.

Example can be found in the official GitHub-repository for Entur

FareDemandFactor < QualityStructureFactor < FareStructureFactor < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

FareDemandType

FareDemandTypeEnumeration

0: 1

TIME DEMAND TYPE corresponding to FARE DEMAND FACTOR.

Allowed values:

  • peak

  • middle

  • offPeak

  • superOffPeak

  • night

  • specialEvent

element

TimeDemandTypeRef

TimeDemandTypeRef

0: 1

Reference to TIME DEMAND TYPE corresponding to the FARE DEMAND FACTOR.

element

StopUseConstraint

StopUseConstraintEnumeration

0: 1

Nature of constraint on uses of stop.

Allowed values:

  • arriving

  • departing

  • passingThrough

element

startTimesAtStopPoints

StartTimeAtStopPoint

0: *

Start times at SCHEDULED STOP POINTs for FARE DEMAND TYPE.

...

Info

A time at which a fare time band (time band peak, off peak) is deemed to begin for trips starting at a particular SCHEDULED STOP POINT.

Example can be found in the official GitHub-repository for Entur

StartTimeAtStopPoint < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ScheduledStopPointRef

ScheduledStopPointRef

1: 1

SCHEDULED STOP POINT at which time band start applies.

element

StartTime

0: 1

Time at which time band starts at referenced SCHEDULED STOP POINT.

element

EndTime

0: 1

Time at which time band ends at referenced SCHEDULED STOP POINT.

element

DayOffset

xsd:integer

0: 1

Day offset of end time from start time. (Zero denotes same day.)

...

Info

A named set of parameters defining number of quota fares available. of a given denomination.

Example can be found in the official GitHub-repository for Entur

FareQuotaFactor < QualityStructureFactor < FareStructureFactor < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

NumberOfUnits

xsd:integer

1: 1

Number of units available of product at a given price.

...

Info

A cell of an origin-destination matrix for TARIFF ZONEs or STOP POINTs, expressing a fare distance for the corresponding trip: value in km, number of fare units etc.

Describes point to point or zone to zone fares, representing the fare between an origin and a destination pair, including its different routing constraint.

Example can be found in the official GitHub-repository for Entur

DistanceMatrixElement < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Distance

DistanceType

0: 1

Distance between origin and destination of a DISTANCE MATRIX ELEMENT

element

RelativeRanking

xsd:integer

0: 1

Relative preference assigned to this element if there are multiple entries between two points

element

IsDirect

xsd:boolean

0: 1

Whether journey is direct or requires changes

element

InverseAllowed

element

0: 1

Whether an inverse element in the opposite direction with the same prices may be assumed – optimisation to reduce data volumes

(choice) element

StartStopPointRef

ScheduledStopPointRef

1: 1

Start SCHEDULED STOP POINT at which a DISTANCE MATRIX ELEMENT begins.

StartTariffZoneRef

TariffZoneRef

Start TARIFF ZONE at which a DISTANCE MATRIX ELEMENT begins

StartFareSectionRef

FareSectionRef

Start FARE SECTION at which a DISTANCE MATRIX ELEMENT begins

(choice) element

EndStopPointRef

ScheduledStopPointRef

1: 1

End SCHEDULED STOP POINT at which a DISTANCE MATRIX ELEMENT ends

EndTariffZoneRef

TariffZoneRef

Final TARIFF ZONE at which a DISTANCE MATRIX ELEMENT ends

StartFareSectionRef

FareSectionRef

End FARE SECTION at which a DISTANCE MATRIX ELEMENT ends

element

prices

DistanceMatrixElementPriceRef

0: 1

A set of all possible price features of a DISTANCE MATRIX ELEMENT: default total price etc.

...

Info

A sequence or set of CONTROLLABLE ELEMENTs to which rules for limitation of access rights and calculation of prices (fare structure) are applied.

Example can be found in the official GitHub-repository for Entur

FareStructureElement < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

TariffBasis

TariffBasisEnumeration

0: 1

TARIFF BASIS to be used for the element

Allowed values:

  • flat

  • distance

  • route

  • zone

  • period

  • tour

  • group

(choice) element

validityParameterAssignments

GenericParameterAssignment

1: *

VALIDITY (i.e. GENERIC) PARAMETER ASSIGNMENTs for an element

fareStructureElementsInSequence

FareStructureElementInSequence

Use of FARESTRUCTURE ELEMENTs in a particular sequence

element

prices

FareStructureElementPriceRef

0: *

A set of all possible price features of a FARE STRUCTURE ELEMENT: default total price, discount in value or percentage etc.

...

FareStructureElementInSequence < FareElementInSequence < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

FareStructureElementRef

FareStructureElementRef

0: 1

Reference to a FARE STRUCTURE ELEMENT

element

ValidableElementRef

FareStructureElementRef

0: 1

Reference to a VALIDABLE ELEMENT

Note: We do currently not want to allow "backwards" referencing

element

validityParameterAssignments

ValidityParameterAssignment

0: *

VALIDITY PARAMETER ASSIGNMENTs associated with the ELEMENT IN SEQUENCE

Note: Should be assigned in the referred GenericParameterAssignment(s), NOT contained as part of the sequence

...

GenericParameterAssignment < ValidityParameterAssignment < AccessRightParameterAssignment < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

TypeOfAccessRightAssignmentRef

TypeOfAccessRightAssignmentRef

0: 1

Classification of ACCESS RIGHT PARAMETER ASSIGNMENT.

See predefined TYPE OF ENTITYs for allowed values.

element

LimitationGroupingType

LogicalOperationEnumeration

0: 1

Logical operator for combining USAGE PARAMETERs elements. The default is ‘AND’.

‘OR’ and ‘XOR’ should only be used if parameters are all of the same type

Allowed values:

  • AND (default, i.e. interpreted as such if not stated) = 
    Successive elements are logically ANDed together; comparison must satisfy all specified values

  • OR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value

  • NOT =
    Specified elements must be different from the given value

  • XOR =
    Successive elements are logically ORed together; comparison must satisfy only one of the specified values

  • NAND =
    Successive elements are logically ANDed together; comparison must satisfy all specified values. The result is then negated.

  • NOR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value. The result is then negated.

  • XNOR =
    Successive elements are logically ORed together; comparison must satisfy only one specified value. The result is then negated.

element

LimitationSetSelectionType

SetOperatorEnumeration

0: 1

Where one or more parameter is a group containing multiple elements, (GROUP OF xxx), set operator for distinguishing between whole set and item interpretation of elements which are sets of elements

I.e. only to be used in relation to GroupOf… parameters, not to evaluate combinations of singular parameters

Allowed values:

  • oneOfAnyOneSet
    (only one item from all  referenced GROUPs OF ENTITies of a given type may be selected/has been selected)

  • oneOfEachSet
    (one item from each specified referenced GROUP OF ENTITies of a given type shall be selected/has been selected)

  • someOfAnySet
    (multiple items from any referenced GROUP OF ENTITies of a given type may be selected/have been selected)

  • allOfOneSet
    (all items from one specified  referenced GROUP OF ENTITies of a given type may be selected/have been selected)

  • allOfAllSets
    (all items from all  referenced GROUPs OF ENTITies of a given type may be selected/have been selected)

element

limitations

UsageParameter

1: *

Limitations (i.e. limitation of use) for the assignment

element

ValidityParameterAssignmentType

RelativeOperatorEnumeration

0: 1

Comparison operator for matching validity parameter values

Allowed values:

  • EQ (default) = 
    Equal (parameter value must have the same identity, or have a value equal to a quantitative value associated with the specified item)

  • NE =
    Not Equal (parameter value must not have the same identity, or have a value different from a quantitative value associated with the specified item)

  • GT =
    Greater than (parameter value must be greater than a quantitative value associated with the specified item)

  • GE = 
    Greater than or equal (parameter value must be greater than or equal to a quantitative value associated with the specified item)

  • LT =
    Less than (parameter value must be less than a quantitative value associated with the specified item)

  • LE = 
    Less than or equal (parameter value must be less than or equal to a quantitative value associated with the specified item)

element

ValidityParameterGroupingType

LogicalOperationEnumeration

0: 1

Logical operator for combining network validity parameters, e.g. ‘AND’ / ‘OR’ / ‘NOT’ / ‘XOR’

‘OR’ and ‘XOR’ should only be used if parameters are all of the same type

Allowed values:

  • AND (default, i.e. interpreted as such if not stated) = 
    Successive elements are logically ANDed together; comparison must satisfy all specified values

  • OR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value

  • NOT =
    Specified elements must be different from the given value

  • XOR =
    Successive elements are logically ORed together; comparison must satisfy only one of the specified values

  • NAND =
    Successive elements are logically ANDed together; comparison must satisfy all specified values. The result is then negated.

  • NOR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value. The result is then negated.

  • XNOR =
    Successive elements are logically ORed together; comparison must satisfy only one specified value. The result is then negated.

element

ValidityParameterSetSelectionType

SetOperatorEnumeration

0: 1

Where one or more parameter is a group containing multiple elements, (GROUP OF xxx), set operator for distinguishing between whole set and item interpretation of elements which are sets of elements

I.e. only to be used in relation to GroupOf… parameters, not to evaluate combinations of singular parameters

Allowed values:

  • oneOfAnyOneSet
    (only one item from all  referenced GROUPs OF ENTITies of a given type may be selected/has been selected)

  • oneOfEachSet
    (one item from each specified referenced GROUP OF ENTITies of a given type shall be selected/has been selected)

  • someOfAnySet
    (multiple items from any referenced GROUP OF ENTITies of a given type may be selected/have been selected)

  • allOfOneSet
    (all items from one specified  referenced GROUP OF ENTITies of a given type may be selected/have been selected)

  • allOfAllSets
    (all items from all  referenced GROUPs OF ENTITies of a given type may be selected/have been selected)

element

temporalValidityParameters

TemporalValidityParametersStructure

0: *

Temporal validity parameters for the assignment

element

validityParameters

ValidityParametersStructure

0: *

Validity parameters for the assignment

element

TimeIntervalRef

TimeIntervalRef

0: 1

References to TIME INTERVALS pertaining to FARE STRUCTURE ELEMENT

element

GeographicalIntervalRef

GeographicalIntervalRef

0: 1

References to GEOGRAPHICAL INTERVALS pertaining to FARE STRUCTURE ELEMENT

element

QualityStructureFactorRef

QualityStructureFactorRef

0: 1

References to QUALITY STRUCTURE FACTORs pertaining to FARE STRUCTURE ELEMENT

element

IncludesGroupingType

LogicalOperationEnumeration

0: 1

Logical operator for combining included elements, i.e. nesting of the included GenericParameterAssignments. The default is ‘OR’.

‘OR’ and ‘XOR’ should only be used if parameters are all of the same type

Allowed values:

  • OR (default, i.e. interpreted as such if not stated) =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value

  • AND = 
    Successive elements are logically ANDed together; comparison must satisfy all specified values

  • NOT =
    Specified elements must be different from the given value

  • XOR =
    Successive elements are logically ORed together; comparison must satisfy only one of the specified values

  • NAND =
    Successive elements are logically ANDed together; comparison must satisfy all specified values. The result is then negated.

  • NOR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value. The result is then negated.

  • XNOR =
    Successive elements are logically ORed together; comparison must satisfy only one specified value. The result is then negated.

element

includes

GenericParameterAssignmentInContext

0: *

A list of VALIDITY PARAMETER ASSIGNMENT without ID constraint used only in the given context specifying practical parameters during a TRAVEL GenericATION, within a given fare structure (e.g. the origin or destination zone in a zone-counting system)

...

Info

A sequence or set of FARE STRUCTURE ELEMENTs, grouped together to be validated in one go.

Example can be found in the official GitHub-repository for Entur

ValidableElement PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

fareStructureElements

FareStructureElement

1: *

FARE STRUCTURE ELEMENTs making up VALIDABLE ELEMENT.

element

prices

FareStructureElementPriceRef

0: *

A set of all possible price features of a FARE STRUCTURE ELEMENT: default total price, discount in value or percentage etc.

...

Info

Abstract parameter type specifying the use of a SALES OFFER PACKAGE or a FARE PRODUCT.

UsageParameter < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

prices

UsageParameterPriceRef

0: *

Prices associated with USAGE PARAMETER

...

Info

The social profile of a passenger, based on age group, education, profession, social status, sex etc., often used for allowing discounts: 18-40 years old, graduates, drivers, unemployed, women etc.

Example can be found in the official GitHub-repository for Entur

UserProfile < UsageParameter < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

TypeOfConcessionRef

TypeOfConcessionRef

0: 1

Classification by type of concession (eligibility for discount)

Note: TypeOfConcession defineres som TypeOfValue (i ResourceFrame) for å gruppere/kategorisere passasjerer som kvalifiserer til rabatt, men datatypen inneholder i praksis kun fritekst-beskrivelser og er lite egnet for kategorisering. Gir upresis klassifisering av data og anbefales derfor ikke å bruke.

element

UserType

UserTypeEnumeration

1: 1

User types

Allowed values:

  • adult (normally equal to "anyone")

  • animal

  • anyone (normally equal to "adult")

  • child

  • disabled

  • disabledCompanion

  • employee

  • infant

  • jobSeeker

  • military

  • schoolPupil

  • senior

  • student

  • youngPerson

element

MinimumAge

xsd:integer

0: 1

Minimum age to be eligible for profile

element

MaximumAge

xsd:integer

0: 1

Maximum age to be eligible for profile

element

ProofRequired

ProofOfIdentityEnumeration

0: 1

Type of proof required

Allowed values:

  • noneRequired

  • creditCard

  • passport

  • drivingLicence

  • membershipCard

  • identityDocument

  • medicalDocument

  • studentCard

  • letterWIthAddress

  • measurement

element

DiscountBasis

DiscountBasisEnumeration

0: 1

Discount for this profile.

Allowed values:

  • none

  • free

  • discount

element

CompanionProfileRef

CompanionProfileRef

0: 1

COMPANION PROFILEs describing users who may travel with user

...

Info

A time limitation for validity of a FARE PRODUCT or a SALES OFFER PACKAGE. It may be composed of a standard duration (e.g. 3 days, 1 month) and/or fixed start/end dates and times.

Example can be found in the official GitHub-repository for Entur

UsageValidityPeriod < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ValidityPeriodType


UsageValidityTypeEnumeration

0: 1

Type of usage validity period

Allowed values (NB: XSD does not match spec, hence this list complies to XSD, inconsistencies have been reported to CEN):

  • singleRide

  • singleTrip

  • returnTrip

  • carnet (a fixed number of individual trips)

  • dayPass

  • weeklyPass

  • weekendPass

  • monthlyPass

  • annualPass

  • seasonTicket

  • profileMembership

  • openEnded

element

UsageTrigger

UsageTriggerEnumeration

0: 1

Trigger event that starts validity period

Allowed values:

  • startOfPeriod

  • startOutboundRide

  • endOutboundRide

  • startReturnRide

  • purchase

  • specifiedStartDate

  • fulfilment

  • dayOffsetBeforeCalendarPeriod

element

UsageEnd

UsageEndEnumeration

0: 1

Classification of when the end of the Usage validity period occurs. May be a specified period (Standard Duration) or an event, e.g. end of trip

Allowed values:

  • standardDuration

  • endOfCalendarPeriod

  • endOfRide

  • endOfTrip

  • endOfFareDay

  • endOfFarePeriod

  • productExpiry

  • profileExpiry

(choice)

element

StandardDuration

xsd:duration

0: 1

Duration of VALIDITY PERIOD after departure. or validation

SteppedDuration

SteppedDuration

0: 1

Duration of VALIDITY PERIOD expressed by steps traveled

element

ActivationMeans

ActivationMeansEnumeration

0: 1

Means of activating start of period

Allowed values:

  • noneRequired

  • checkIn

  • useOfValidator

  • useOfMobileDevice

  • automaticByTime

  • automaticByProximity

  • other

element

StartDate

xsd:date

0: 1

Start date of  USAGE VALIDITY PERIOD, use to specify a fixed period

element

StartTime

xsd:time

0: 1

Start time of  USAGE VALIDITY PERIOD, use to specify a fixed period

element

EndDate

xsd:date

0: 1

End Date of  USAGE VALIDITY PERIOD, use to specify a fixed period

element

EndTime

xsd:time

0: 1

End time of  USAGE VALIDITY PERIOD, use to specify a fixed period

element

UsageStartConstraintType

UsageStartConstraintTypeEnumeration

0: 1

Whether start type of trip or pass  is  variable or fixed

Default is variable.

Allowed values:

  • variable

  • fixed

  • fixedWindow

element

startOnlyOn

DayTypeRef

0: *

If UsageStartConstraintType is "fixed", then allowed days to start on can be indicated by a DAY TYPE, for example Monday, 1st of Month, Start of Quarter, etc. (Applies mainly  to Passes.)

todo - blir dette riktig?

element

FixedStartWindow

FixedStartWindow

0: 1

If UsageStartConstraintType is "fixedWindow" , then can specify a window relative to booked train for alternative services that may be used

...

Info

Conditions governing temporary suspension of a FARE PRODUCT, (i.e. period pass or subscription).

Example can be found in the official GitHub-repository for Entur

Suspending < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SuspensionPolicy

SuspensionPolicyListOfEnumerations

0: 1

Policies for suspending term of product

Allowed values (multiple can be used simultaneously):

  • forCertifiedIllness

  • forParentalLeave

  • forHoliday

  • forAnyReason

element

QualificationPeriod

xsd:duration

0: 1

Minimum duration that shall have occurred before a suspension is allowed

element

MinimumSuspensionPeriod

xsd:duration

0: 1

Minimum duration allowed for a suspension

element

MaximumSuspensionPeriod

xsd:duration

0: 1

Maximum duration allowed for a suspension

element

MaximumNumberOfSuspensionsPerTerm

xsd:nonNegativeInteger

0: 1

Maximum number of suspensions for the related term

...

Info

Properties relating to single or return trip use of an access right.

Example can be found in the official GitHub-repository for Entur

RoundTrip < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

TripType

RoundTripTypeEnumeration

0: 1

Type of trip

Allowed values:

  • single (default)

  • return (outbound and return)

  • returnOut (outbond part)

  • returnBack (return part)

  • multiple

  • returnOnly

element

DoubleSingleFare

xsd:boolean

0: 1

Whether fare for return trip is simply double the single fare

element

IsRequired

xsd:boolean

0: 1

Whether return trip is required

...

Info

The limits of usage frequency for a FARE PRODUCT (or one of its components) or a SALES OFFER PACKAGE during a specific VALIDITY PERIOD. There may be different tariffs depending on how often the right is consumed during the period.

Example can be found in the official GitHub-repository for Entur

FrequencyOfUse < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

FrequencyOfUseType

FrequencyOfUseTypeEnumeration

0: 1

Type of Frequency of Use

Allowed values:

  • single (default)

  • none (i.e. no interchange allowed)

  • limited

  • unlimited

  • twiceADay

  • twiceADay

element

MinimalFrequency

xsd:integer

0: 1

Minimum number of times can be used.

element

MaximalFrequency

xsd:integer

0: 1

Maximum number of times can be used.

...

Info

Limitations on making changes within a trip.

Example can be found in the official GitHub-repository for Entur

Interchanging < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CanInterchange

xsd:boolean

0: 1

Whether an interchange can be made

element

FromMode

VehicleModeEnumeration

0: 1

Mode from which interchange is made

Allowed values:

  • air

  • bus

  • coach

  • metro

  • rail

  • tram

  • water

  • cableway

  • funicular

element

ToMode

VehicleModeEnumeration

0: 1

Mode to which interchange is made

Allowed values:

  • air

  • bus

  • coach

  • metro

  • rail

  • tram

  • water

  • cableway

  • funicular

element

MaximumNumberOfInterchanges

xsd:integer

0: 1

Maximum number of  interhanges between SERVICE JOURNEYs that can be made in a single TRIP

element

MaximumTimeToMakeATransfer

xsd:duration

0: 1

Maximum time to transfer between SERVICE JOURNEYs in a single TRIP

element

CanBreakJourney

xsd:boolean

0: 1

Whether the journey can be broken at an interchange point

element

CrossBorder

xsd:boolean

0: 1

Whether interchanging crosses a border
Whether interchanging is allowed to cross a border

...

Info

Period in which the product can be purchased.

Example can be found in the official GitHub-repository for Entur

LuggageAllowance < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

BaggageUseType

BaggageUseTypeEnumeration

0: 1

Type of Baggage use

Allowed values:

  • carryOn

  • checkIn

  • oversizeCheckIn

  • baggageCompartment

element

BaggageType

BaggageTypeEnumeration

0: 1

Type of Baggage described by allowance

Allowed values:

  • animal

  • bicycle

  • game

  • handbag

  • handLuggage

  • largeMotorizedWheelchair

  • motorcycle

  • motorizedWheelchair

  • musicalnstrument

  • oversizeItem

  • pushChair

  • skis

  • smallAnimal

  • smallSuitcase

  • sportingEquipment

  • suitcase

  • trunk

  • wheelchair

element

LuggageAllowanceType

LuggageAllowanceTypeEnumeration

0: 1

Classification of allowance type

Allowed values:

  • none

  • limited

  • singleBag

  • unlimited

element

MaximumNumberItems

xsd:nonNegativeInteger

0: 1

Number of items allowed for this allowance

element

MaximumBagHeight

xsd:decimal

0: 1

Maximum height of a bag

element

MaximumBagWidth

xsd:decimal

0: 1

Maximum width of a bag.

element

MaximumBagDepth

xsd:decimal

0: 1

Maximum depth of a bag

element

MaximumBagWeight

xsd:decimal

0: 1

Maximum weight of one bag

element

TotalWeight

xsd:decimal

0: 1

Total maximum weight limit (in kilograms) for this allowance

element

LuggageChargingBasis

LuggageChargingBasisEnumeration

0: 1

Basis on which luggage is charged

Allowed values:

  • free

  • chargedByItem (per colli)

  • chargedByWeight (total weight)

...

Info

Period in which the product can be purchased.

Example can be found in the official GitHub-repository for Entur

PurchaseWindow < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

PurchaseAction

PurchaseActionEnumeration

1: 1

Action governed by Purchase Window

Allowed values:

  • purchase (default)

  • reserve

element

PurchaseWhen

PurchaseWhenEnumeration

1: 1

When purchase may be made

Allowed values:

  • advanceAndDayOfTravel (default)

  • advanceOnly

  • dayOfTravelOnly

  • timeOfTravelOnly

  • untilPreviousDay

element

LatestTime

xsd:time

0: 1

Latest time on specified last day when ticket can be purchased

element

MinimumPeriodBeforeDeparture

xsd:duration

0: 1

Minimum duration before departure that ticket may be purchased

element

MaximumPeriodBeforeDeparture

xsd:duration

0: 1

Maximum duration before departure that ticket may be purchased

element

PurchaseMoment

PurchaseMomentListOfEnumerations


Permitted moments of purchase

Allowed values (multiple can be used simultaneously):

  • inAdvance

  • beforeBoarding

  • afterBoarding

  • onCheckIn

  • onReservation

...

Note

TODO: Verifisere at ikke flere elementer behøver å være med her.

(Se TEMPORARY - Unused NeTEx part 3 Fares data objects (Fare and SalesTransaction frames) /wiki/spaces/AR/pages/585105589 )

Reserving < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ReservingRequirements

ServiceReservationFacilityListOfEnumerations

0: *

List of of resrevation requriements

Allowed values (multiple):

  • reservationsCompulsory

  • reservationsCompulsoryForGroups

  • reservationsPossible

  • noGroupsAllowed

  • noReservationsPossible

  • wheelchairOnlyReservations

  • bicycleReservationsCompulsory

  • reservationsCompulsoryForFirstClass

  • reservationsCompulsoryFromOriginStation

  • reservationsRecommended

  • reservationsPossibleOnlyInFirstClass

  • reservationsPossibleOnlyInSecondClass

  • reservationsPossibleForCertainClasses

  • groupBookingRestricted

  • reservationsSupplementCharged

element

BookingArrangements

BookingArrangementsStructure

0: 1

Booking Arrangements for reservations

...

Info

Requirements for cancelling a booking.

Example can be found in the official GitHub-repository for Entur

Cancelling < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

BookingArrangements

BookingArrangementsStructure

0: 1

Booking Arrangements for cancellations

...

Info

Policy regarding different aspects of charging such as credit limits.

Example can be found in the official GitHub-repository for Entur

ChargingPolicy < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CreditPolicy

TravelCreditPolicyEnumeration

0: 1

Policy for traveling on credit

Allowed values:

  • allowTravel

  • blockPayAsYouGoTravel

  • blockAllTravel

element

BillingPolicy

TravelBillingPolicyEnumeration

0: 1

Policy for billing frequency

Allowed values:

  • billAsYouGo

  • billOnThreshold

  • billAtFareDayEnd

  • billAtPeriodEnd

...

Info

Policy regarding different aspects of penalty charges, for example repeated entry at the same station, no ticket etc.

Example can be found in the official GitHub-repository for Entur

PenaltyPolicy < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

PenaltyPolicyType

PenaltyPolicyTypeEnumeration

0: 1

Classification of Penalty Policy

Allowed values:

  • noTicket

  • noValidation

  • noCheckin

  • noCheckout

element

PenaltyAction

(forslag til NeTEx utvidelse)

PenaltyActionEnumeration

(forslag til NeTEx utvidelse, dvs inkl ny enumeration)

1: 1

Classification of Penalty Action

Allowed values:

  • fine

  • ...??? (TODO - må revideres)

element

PaymentMethod

(forslag til NeTEx utvidelse, bør implementeres som liste slik at det fungerer å legge inn flere betalingsalternativer per policy)

PaymentMethodListOfEnumerations

0: 1

Available penalty payment methods

Allowed values:

  • creditCard

  • debitCard

  • cardsOnly

  • travelCard

  • bankTransfer

  • sms

  • mobilePhone

  • voucher

  • cash

  • cashAndCard

  • coin

  • banknote

  • cheque

  • travellersCheque

  • postalOrder

  • companyCheque

  • contactlessPaymentCard

  • contactlessTravelCard

  • directDebit

  • token

  • warrant

  • mileagePoints

...

Info

Parameters governing subscription to a product allowing payment at regular intervals.

Example can be found in the official GitHub-repository for Entur

Subscribing < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SubscriptionTermType

SubscriptionTermTypeEnumeration

0: 1

Types of subscription term allowed

 Allowed values:

  • fixed

  • openEnded

element

MinimumSubscriptionPeriod

xsd:duration

0: 1

Minimum duration allowed for a subscription

element

MaximumSubscriptionPeriod

xsd:duration

0: 1

Maximum duration allowed for a subscription

element

SubscriptionRenewalPolicy

SubscriptionRenewalPolicyEnumeration

0: 1

Policy on renewing subscription

 Allowed values:

  • automatic

  • manual

  • none (for termination of subscription type)

element

possibleInstallmentIntervals

TimeIntervalRef

0: *

Allowed billing Intervals for payment in instalment

element

InstallmentPaymentMethods

PaymentMethodListOfEnumerations

0: 1

Allowed means of payment of installations as standard value

 Allowed values (multiple can be used simultaneously):

  • bankTransfer

  • creditCard

  • debitCard

  • travelCard

  • sms

...

Info

The number and characteristics of persons entitled to travel in addition to the holder of an access right.

Example can be found in the official GitHub-repository for Entur

GroupTicket < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

MinimumNumberOfPersons

xsd:integer

0: 1

Minimum number of persons overall allowed on ticket

element

MaximumNumberOfPersons

xsd:integer

0: 1

Maximum number of persons overall allowed on ticket

element

companionProfiles

CompanionProfileRef

0: *

The number and characteristics of a category of users allowed on the ticket

element

PricingBasis

PricingBasisEnumeration

0: 1

Discount for this profile.

Allowed values:

  • perOffer

  • perPerson

element

JointCheckIn

GroupCheckInEnumeration

0: 1

Whether the group must check in together

Allowed values:

  • none

  • required

  • allowed

element

GroupBookingFacility

GroupBookingEnumeration

0: 1

Classification of GROUP FACILITY type (TPEG pti23)

Allowed values:

  • groupsAllowed

  • groupsNotAllowed

  • groupsAllowedWithReservation

  • groupBookingsRestricted

...

Info

The COMPANION PROFILE specifies the number and characteristics of persons entitled to travel in addition to the holder of an access right, for example children, wheelchair carer, etc.

Example can be found in the official GitHub-repository for Entur

CompanionProfile < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CompanionRelationshipType

CompanionRelationshipEnumeration

1: 1

Required Relationship of companion to eligible user

Allowed values:

  • anyone

  • carer

  • child

  • dependent

  • family

  • partner

  • teacher

  • pupil

element

MinimumNumberOfPersons

xsd:integer

0: 1

Minimum number of persons overall allowed of this type

element

MaximumNumberOfPersons

xsd:integer

0: 1

Maximum number of persons overall allowed of this type

element

DiscountBasis

DiscountBasisEnumeration

0: 1

Nature of discount for this type of user

Allowed values:

  • none

  • free

  • discount

...

Info

A category of users depending on their commercial relations with the operator (frequency of use, amount of purchase etc.), often used for allowing discounts.

Example can be found in the official GitHub-repository for Entur

CommercialProfile < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CommercialProfile inherits from UsageParameter without introducing new elements or attributes.

...

Info

The number and characteristics of persons entitled to use the public transport service instead of the original customer.

Example can be found in the official GitHub-repository for Entur

Transferability < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CanTransfer

xsd:boolean

0: 1

Whether ticket can be transferred to someone else

element

MaximumNumberOfNamedTransferees

xsd:nonNegativeInteger

0: 1

Where a product can be used by a limited number of named users, maximum number of users allowed.

element

HasTransferFee

xsd:boolean

0: 1

Whether there is a fee for a refund or exchange

element

SharedUsage

ResellWhenEnumeration

0: 1

Indicates the nature of the permitted sharing, if any, of products that can be shared, e.g. Trips from a multi-trip carnet

 Allowed values:

  • singleUser

  • concurrentUsers (multiple users at the same time)

  • concurrentDesignatedUsers (multiple users at the same time, but only designated companions)

...

Info

Common resale conditions (i.e. for exchange or refund) attaching to the product.

Example can be found in the official GitHub-repository for Entur

Reselling < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Allowed

ResellTypeEnumeration

0: 1

Whether exchange or refund is allowed

Allowed values:

  • none

  • partial

  • full

element

UnusedTicketsOnly

xsd:boolean

0: 1

Whether it is possible to exchange partially used tickets

element

ResellWhen

ResellWhenEnumeration

0: 1

Event marking when the exchangeable status of the ticket changes

 Allowed values (NB: XSD does not match spec, hence this list complies to XSD):

  • never

  • beforeFirstUse

  • afterFirstUse

  • beforeStartOfValidity

  • afterStartOfValidity

  • afterEndOfValidity

  • beforeValidation

  • afterValidation

  • anyTime

element

ExchangeableFromDuration

xsd:duration

0: 1

Duration to start of period before (negative) or after (positive) the trigger point (i.e. either Start Of Validity or First Use) or that ticket may be exchanged or refunded

element

ExchangeableUntilDuration

xsd:duration

0: 1

Duration to end of period before (negative) or after  (positive) the trigger point (i.e. either Start Of Validity or First Use) that ticket may be exchanged or refunded

element

HasFee

xsd:boolean

0: 1

Whether there is a fee for a refund or exchange

element

RefundBasis

PerBasisEnumeration

0: 1

Basis on which refund is made

Allowed values:

  • perOffer

  • perPerson

...

Info

Whether and how the product may be refunded.

Example can be found in the official GitHub-repository for Entur

Refunding < Reselling < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Allowed

ResellTypeEnumeration

0: 1

Whether exchange or refund is allowed

Allowed values:

  • none

  • partial

  • full

element

CanChangeClass

xsd:boolean

0: 1

Whether user can change class

element

UnusedTicketsOnly

xsd:boolean

0: 1

Whether it is possible to exchange partially used tickets

element

ResellWhen

ResellWhenEnumeration

0: 1

Event marking when the is exchangable status of the ticket changes

Allowed values:

  • never

  • beforeStartOfValidity

  • afterStartOfValidity

  • afterEndOfValidity

  • beforeFirstUse

  • afterFirstUse

  • beforeValidation

  • afterValidation

  • anyTime

  • afterSale (tillegg)

TODO - Må revideres - NB: "afterSale" finnes (foreløpig) ikke i enum'en

element

ExchangableFromDuration

xsd:duration

0: 1

Duration to start of period before (negative) or after (positive) the trigger point (i.e. either Start of Validity or First Use ) or that ticket

element

ExchangableUntilDuration

xsd:duration

0: 1

Duration to end of period before (negative) or after (positive) the trigger point (i.e. either Start of Validity or First Use ) or that ticket

element

HasFee

xsd:boolean

0: 1

Whether there is a feed for reselling

element

RefundBasis

PerBasisEnumeration

0: 1

Basis for which refund is given

AllowedValues:

  • perOffer

  • perPerson

element

RefundType

RefundTypeEnumeration

0: 1

Type of Refund

Allowed values:

  • unused

  • delay

  • cancellation

  • partialJourney

TODO - Kun mulig å angi én, vurdere om CHANGE REQUEST for å gjøre til liste (mulig workaround å definere redundante Refund-objekter)

element

PaymentMethod

PaymentMethodListOfEnumerations

0: 1

Payment methods allowed to make refund

Allowed values:

  • cash

  • cashAndCard

  • coin

  • banknote

  • cheque

  • travellersCheque

  • postalOrder

  • companyCheque

  • creditCard

  • debitCard

  • cardsOnly

  • travelCard

  • contactlessPaymentCard

  • contactlessTravelCard

  • sms

  • mobilePhone

  • voucher

  • token

  • warrant

TODO - Kun mulig å angi én, vurdere om CHANGE REQUEST for å gjøre til liste (mulig workaround å definere redundante Refund-objekter)

...

Info

Whether and how access rights may be exchanged for other access rights.

Example can be found in the official GitHub-repository for Entur

Exchanging < Reselling < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Allowed

ResellTypeEnumeration

0: 1

Whether exchange or refund is allowed

Allowed values:

  • none

  • partial

  • full

element

UnusedTicketsOnly

xsd:boolean

0: 1

Whether it is possible to exchange partially used tickets

element

HasFee

xsd:boolean

0: 1

Whether there is a fee for a refund or exchange

element

ExchangeableFromDuration

xsd:duration

0: 1

Duration to start of period before (negative) or after (positive) the trigger point (i.e. either Start Of Validity or First Use) or that ticket may be exchanged or refunded

element

ExchangeableUntilDuration

xsd:duration

0: 1

Duration to end of period before (negative) or after  (positive) the trigger point (i.e. either Start Of Validity or First Use) that ticket may be exchanged or refunded

element

ResellWhen

ResellWhenEnumeration

0: 1

Event marking when the exchangeable status of the ticket changes

 Allowed values (NB: XSD does not match spec, hence this list complies to XSD):

  • never

  • beforeFirstUse

  • afterFirstUse

  • beforeStartOfValidity

  • afterStartOfValidity

  • afterEndOfValidity

  • beforeValidation

  • afterValidation

  • anyTime

element

NumberOfExchangesAllowed

xsd:integer

0: 1

Whether it is possible to exchange partially used tickets

element

ToFareClass

FareClassEnumeration

0: 1

Fare class to which can be exchanged.

 Allowed values:

  • any

  • businessClass

  • economyClass

  • firstClass

element

ExchangeableTo

ExchangableToEnumeration

0: 1

Type of exchange allowed. The default is ‘anyProduct’, i.e. to any other fare.

 Allowed values:

  • anyProduct

  • sameProductSameDay

  • sameProductAnyDay

  • upgradeToStandardFare

  • upgradeToSpecifiedFare

...

Info

Whether and how access rights may be replaced if lost or stolen.

Example can be found in the official GitHub-repository for Entur

Replacing < Reselling < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Allowed

ResellTypeEnumeration

0: 1

Whether exchange or refund is allowed

Allowed values:

  • none

  • partial

  • full

element

UnusedTicketsOnly

xsd:boolean

0: 1

Whether it is possible to exchange partially used tickets

element

HasFee

xsd:boolean

0: 1

Whether there is a fee for a refund or exchange

...

Info

Common rules describing reverting of activations and markings of CUSTOMER PURCHASE PACKAGE ELEMENT ACCESS (“tickets”) in case the traveller, conductor og customer service representative or others accidentially activates/validates/uses the wrong FARE CONTRACT (“ticket”).

Example can be found in the official GitHub-repository for Entur

Reverting < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

TypeOfResponsibilityRoleRef

TypeOfResponsibilityRoleRef

1: 1

Type of role required of the part initiating the reverting (ie self service, customer service, conductor etc)

Must refer to a valid (i.e. predefined) ResponsibilityRole.

element

MinimumTimeAfterUse

xsd:duration

0: 1

Minimum time after erranous activation/use of the ticket the reverting is allowed

element

MaximumTimeAfterUse

xsd:duration

0: 1

Maximum time after erranous activation/use of the ticket the reverting is allowed

element

AllowedAfterControl

xsd:boolean

1: 1

Whether ticket can be reverted after ticket has been exposed to ticket control

...

Info

Rules describing whether it is sufficient to board/validate the SERVICE ACCESS RIGHTs before expiry time in order to travel, or if the SERVICE ACCESS RIGHTsaccess right must be temporally valid for the whole journey.

Example can be found in the official GitHub-repository for Entur

OnboardValidity < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

OnboardValidityType

OnboardValidityTypeEnumeration

1: 1

Nature of ONBOARD VALIDITY.

Allowed values:

  • validAtBoardingTime

  • validAtStartOfServiceJourney

  • validAtAllTimesWhileOnboard

...

Info

Policy regarding different aspects of security, for example required required security level for account based ticketing.

Example can be found in the official GitHub-repository for Entur

SecurityPolicy < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

MinimumAccountSecurityLevel

xsd:nonPositiveInteger

1: 1

Required (minimum) sequrity level of any account that should hold a FareContract representing this product. The value is specified as a negative number, 0 is the highest level of security (most secure).

...

Info

Granting of entitlement to other SERVICE ACCESS RIGHTs (i.e. in another PREASSIGNED dFARE PRODUCT).

Example can be found in the official GitHub-repository for Entur

EntitlementGiven < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

(choice) element

PreassignedFareProductRef

PreassignedFareProductRef

1: 1

Reference to the PREASSIGNED FARE PRODUCT from which the entitled SERVICE ACCESS RIGHT(s) is granted.

Recommended reference type.

ServiceAccessRightRef

ServiceAccessRightRef

Reference to the specific SERVICE ACCESS RIGHT from which entitlement is granted.

Alternative reference type.

I.e. the related PREASSIGNED FARE PRODUCT is indirecly associated if this ACCESS RIGHT only exists for a single product.

element

MinimumQualificationPeriod

xsd:duration

0: 1

Minimum period that the FARE PRODUCT shall be held for entitlement to be granted.

element

EntitlementConstraint

EntitlementConstraintStructure

0: 1

Limits on choices associated with entitlement.

element

EntitlementType

EntitlementTypeEnumeration

0: 1

Type of entitlement.

Allowed values:

  • purchase

  • purchaseAtDiscount

  • use

  • none

...

Info

A specific SERVICE ACCESS RIGHT or PREASSIGNED FARE PRODUCT which is required in order to purchase or use a FARE PRODUCT, or from which required entitlement(s) is (are) received.

Example can be found in the official GitHub-repository for Entur

EntitlementRequired < UsageParameter PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

(choice) element

ServiceAccessRightRef

ServiceAccessRightRef

1: 1

Reference to the specific SERVICE ACCESS RIGHT which is either a precondition, or from which the entitlement is received.

Recommended reference type.

PreassignedFareProductRef

PreassignedFareProductRef

Reference to the PREASSIGNED FARE PRODUCT which is either a precondition, or from which the entitled SERVICE ACCESS RIGHT(s) is (are) received .

Alternative reference type.

I.e. the related PREASSIGNED FARE PRODUCT is indirecly associated if this ACCESS RIGHT only exists for a single product.

element

MinimumQualificationPeriod

xsd:duration

0: 1

Minimum period that the FARE PRODUCT shall be held for entitlement to be granted.

element

EntitlementConstraint

EntitlementConstraintStructure

0: 1

Limits on choices associated with entitlement.

...

Info

Abstract type describing an immaterial marketable element (access rights, discount rights etc).

ServiceAccessRight < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Type

Cardinality

Description

element

PrivateCode

xsd:normalizedString

0: 1

Identifier of SERVICE ACCESS RIGHT

element

InfoUrl

xsd:anyURI

0: 1

Link for product information

...

Info

Abstract type describing an immaterial marketable element (access rights, discount rights etc), specific to a CHARGING MOMENT.

FareProduct < ServiceAccessRight < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Type

Cardinality

Description

element

ChargingMomentRef

FareProductRef

0: 1

Reference to a CHARGING MOMENT for product

element

ChargingMomentType

ChargingMomentEnumeration

0: 1

Standardised charging moment

Allowed values:

  • anyTime

  • beforeTravel

  • onStartOfTravel

  • beforeEndOfTravel

  • onStartThenAdjustAtEndOfTravel

  • onStartThenAdjustAtEndOfFareDay

  • onStartThenAdjustAtEndOfChargePeriod

  • atEndOfTravel

  • atEndOfFareDay

  • atEndOfChargePeriod

  • free

(choice) element

TypeOfFareProductRef

TypeOfFareProductRef

0: 1

Reference to a type of FARE PRODUCT

typesOfFareProductRef

TypeOfFareProductRef

2: *

Multiple refereferences to a type of FARE PRODUCT

element

ConditionSummary

ConditionSummary

0: 1

Summary description of conditions on FARE PRODUCT

element

OperatorRef

OperatorRef

0: 1

Reference to OPERATOR to which ACCESS RIGHT PARAMETER is assigned

element

FareProductRef

FareProductRef

0: 1

Another FARE PRODUCT which this product extends. Will assume all properties of base product unless specifically overridden.

element

validityParameterAssignments

ValidityParameterAssignment

0: 1

Type for a list of VALIDITY PARAMETER ASSIGNMENT.


TODO - se ValidityParameterAssignment - bør begrense til enten ha relevante referanser internt i dette objektet, eller kun assigned (og stryke de overflødige referansene)




ConditionSummary

Info

Summary description of PRODUCT.

Example can be found in the official GitHub-repository for Entur

...

Info

A FARE PRODUCT consisting of one or several VALIDABLE ELEMENTs, specific to a CHARGING MOMENT.

Example can be found in the official GitHub-repository for Entur

PreassignedFareProduct < FareProduct < ServiceAccessRight < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SupplementProductRef

SupplementProductRef

1: 1

Reference to a SUPPLEMENT PRODUCT

element

accessRightsInProduct

AccessRightInProduct

0: *

List ACCESS RIGHT IN PRODUCT for this FARE PRODUCT

element

prices

FarePrice

0: *

PRICEs for this FARE PRODUCT

...

Info

A VALIDABLE ELEMENT as a part of a PRE-ASSIGNED FARE PRODUCT, including its possible order in the set of all VALIDABLE ELEMENTs grouped together to define the access right assigned to that PREASSIGNED FARE PRODUCT.

Example can be found in the official GitHub-repository for Entur

AccessRightInProduct < FareElementInSequence < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ValidableElementRef

ValidableElementRef

0: 1

Reference to a VALIDABLE ELEMENT for which access rights are specified

element

SupplementProductRef

SupplementProductRef

1: 1

Reference to a SUPPLEMENT PRODUCT

Preferably not used as an AccessRight, but rather as a SUPPLEMENT PRODUCT to the FARE PRODUCT itself.

...

Info

An additional FARE PRODUCT that may be used to describe additional purchases entitled by another product. A SUPPLEMENT PRODUCT is usually constrained by some or all of the parameters of the supplemented product, e.g. same service, same route, etc.

Example can be found in the official GitHub-repository for Entur

SupplementProduct < PreassignedFareProduct < FareProduct < ServiceAccessRight < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

PreassignedFareProductRef

PreassignedFareProductRef

1: 1

Reference to base PRE ASSIGNED FARE PRODUCT OFFER for which this is a supplement

TODO:

Går kun an å referere ett FareProduct (dvs enten ett SupplementaryProduct eller en SalesDiscountRight).

 Se FareProductRelationGroup (netex_fareProduct_version.xsd)

Det bør enten fikses, ellers må referansen gå tilbake for akkurat dette datasettet. (Hvilket umuliggjør gjenbruk.)

element

SupplementProductType

SupplementProductEnumeration

1: 1

Classification of SUPPLEMENT PRODUCT

Allowed values:

  • animal

  • bicycle

  • dog

  • eventAddOn

  • extraLuggage

  • journeyAddOn

  • journeyExtension

  • meal

  • parking

  • penalty

  • seatReservation

  • upgrade

  • wifi

...

Info

A FARE PRODUCT that is marketed together with a Public Transport FARE PRODUCT.

Example can be found in the official GitHub-repository for Entur

ThirdPartyProduct < FareProduct < ServiceAccessRight < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

PreassignedFareProductRef

PreassignedFareProductRef

1: 1

Reference to product defintion (PREASSIGNED FARE PRODUCT) for this third party product

element

accessRightsInProduct

AccessRightInProductRef

0: *

Reference to specific ACCESS RIGHT IN PRODUCT for this third party product

element

prices

FareProductPrice

0: *

FARE PRODUCT PRICE specification for this third party product

...

Info

A FARE PRODUCT allowing a customer to benefit from discounts when purchasing SALES OFFER PACKAGEs.

Example can be found in the official GitHub-repository for Entur

SaleDiscountRight < FareProduct < ServiceAccessRight < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ProductType

SaleDiscountRightEnumeration

1: 1

SaleDiscountRightEnumeration

Allowed values:

  • payAsYouGoRight

  • statutoryRight (per regulatory approval)

  • travelCard

...

Info

A specialisation of SALE DISCOUNT RIGHT where the discount is expressed as a capping limit for a given
time interval. For example, the London Oyster card fare, which charges for each journey at a reduced price until travel equivalent to a day pass has been consumed.

Example can be found in the official GitHub-repository for Entur

CappedDiscountRight < SaleDiscountRight < FareProduct < ServiceAccessRight < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

cappingRules

CappingRule

1: 1

List of parameters setting a price cap on a product.

...

Info

A capping limit for a given time interval, where the capping is expressed by another product. For example, the London Oyster card fare, which charges for each journey at a reduced price until travel equivalent to a day pass for the mode of travel has been consumed. A CAPPING RULE is a PRICEABLE OBJECT and may have USAGE PARAMETERS such as a USAGE VALIDITY PERIOD to specify how long the capping period is and a CHARGING POLICY to specify rules about travelling under credit.

Example can be found in the official GitHub-repository for Entur

CappingRule < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

prices

FarePrice

0: *

Capping FARE PRICEs for this rule

...

Info

A package to be sold as a whole, consisting of one or several FARE PRODUCTs materialised thanks to one or several TRAVEL DOCUMENTs. The FARE PRODUCTs may be either directly attached to the TRAVEL DOCUMENTs, or may be reloadable on the TRAVEL DOCUMENTs.

Example can be found in the official GitHub-repository for Entur

SalesOfferPackage < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

PrivateCode

PrivateCodeType

0: 1

Alternative identifier of an entity. can be used to associate with legacy systems.

element

ConditionSummary

ConditionSummary

0: 1

Summary description of SALES OFFER PACKAGE properties

element

validityParameterAssignments

GenericParameterAssignment

0: *

List of VALIDITY PARAMETER ASSIGNMENTs for SALES OFFER PACKAGE

element

distributionAssignments

DistributionAssignment

0: *

List of DISTRIBUTION ASSIGNMENTs for SALES OFFER PACKAGE

Can be defined as separate object and referred, but may be more consistent to have embedded

element

RoundingRef

RoundingRef

0: 1

Reference to a ROUNDING

element

prices

SalesOfferPackagePrice

0: *

List of SALES OFFER PACKAGE PRICEs associated with the SALES OFFER PACKAGE ELEMENT

element

elementConsumptionPolicies

ElementConsumptionPolicy

0: *

List of CONSUMPTION UTILISATION DEPENDENCIES in SALES OFFER PACKAGE

element

salesOfferPackageElements

SalesOfferPackageElement

0: *

List of SALES OFFER PACKAGE ELEMENTs

element

SalesOfferPackageSubstitutions

SalesOfferPackageSubstitution

1: *

List of SALES OFFER PACKAGE SUBSTITUTIONs

...

GroupOfSalesOfferPackages < GroupOfEntities < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

alternativeNames

AlternativeName

0: *

ALTERNATIVE NAMEs for GROUP of SALES OFFER PACKAGEs

element

PricingServiceRef

PricingServiceRef

0: *

PRICING SERVICE to use to fetch prices dynamically

element

PricingRuleRef

PricingRuleRef

0: *

Default PRICING RULE to use to derive prices from this element

element

priceGroups

PriceGroupRef

0: *

PRICE GROUPs associated with this element

(choice) element

fareTables

StandardFareTableRef

0: *

List of FARE TABLEs associated with this element

FareTableRef

element

SalesOfferPackageElements

SalesOfferPackageElement

0: 1

Common properties of SALES OFFER PACKAGE and GROUP OF SALES OFFER PACKAGES

element

members

SalesOfferPackageRef

1: *

References to members of GROUP of SALES OFFER PACKAGEs

...

ElementConsumptionPolicy < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ConsumptionRequirementGroupingType

LogicalOperationEnumeration

0: 1

Logical operator for combining USAGE PARAMETERs elements. The default is ‘AND’.

‘OR’ and ‘XOR’ should only be used if parameters are all of the same type

Allowed values:

  • AND (default, i.e. interpreted as such if not stated) = 
    Successive elements are logically ANDed together; comparison must satisfy all specified values

  • OR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value

  • NOT =
    Specified elements must be different from the given value

  • XOR =
    Successive elements are logically ORed together; comparison must satisfy only one of the specified values

  • NAND =
    Successive elements are logically ANDed together; comparison must satisfy all specified values. The result is then negated.

  • NOR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value. The result is then negated.

  • XNOR =
    Successive elements are logically ORed together; comparison must satisfy only one specified value. The result is then negated.

element

consumptionRequirements

ConsumptionRequirement

0: *

A list of CONSUMPTION REQUIREMENTs defining which state a consumable element (i.e. a CUSTOMER PURCHASE PACKAGE ELEMENT or its ACCESS RIGHT IN PRODUCT) must be in.

element

ConsumptionTriggerType

ConsumptionTriggerTypeEnumeration

1: 1

Specifies whether the Consumptions must be triggered automatically or manually.

Allowed values:

  • manual

  • automatic

element

ElementConsumptionGroupingType

LogicalOperationEnumeration

0: 1

Logical operator for combining USAGE PARAMETERs elements. The default is ‘AND’.

‘OR’ and ‘XOR’ should only be used if parameters are all of the same type

Allowed values:

  • AND (default, i.e. interpreted as such if not stated) = 
    Successive elements are logically ANDed together; comparison must satisfy all specified values

  • OR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value

  • NOT =
    Specified elements must be different from the given value

  • XOR =
    Successive elements are logically ORed together; comparison must satisfy only one of the specified values

  • NAND =
    Successive elements are logically ANDed together; comparison must satisfy all specified values. The result is then negated.

  • NOR =
    Successive elements are logically ORed together; comparison must satisfy at least one specified value. The result is then negated.

  • XNOR =
    Successive elements are logically ORed together; comparison must satisfy only one specified value. The result is then negated.

element

elementConsumptions

ElementConsumption

0: *

A list of ELEMENT CONSUMPTION for specifying how which ELEMENT is to be consumed.

element

crossConstraints

CrossContstraint

0: *

A list of ELEMENTS with CROSS CONSTRAINTs (i.e. constraints across multiple elements)

element

MaximumNumberOfAccesses

MaximumNumberOfAccesses

0: 1

Maximum number of ACCESSes for ELEMENT CONUMPTION POLICY

...

Info

Required ELEMENT CONSUMPTION POLICY elements

Example can be found in the official GitHub-repository for Entur

ConsumptionRequirement < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

(choice) element

ConsumptionRequirement

AccessRightInProductConsumptionRequirement

1: *

The definition of a ELEMENT CONSUMPTION POLICY defining which state a ACCESS RIGHT IN PRODUCT must be in (recorded via CustomerPurchasePackageElementAccesses)

CustomerPurchasePackageElementConsumptionRequirement

The definition of a CONSUMPTION REQUIREMENT defining which state a CUSTOMER PURCHASE PACKAGE ELEMENT must be in (recorded via ElementAccesses)

...

AccessRightInProductConsumptionRequirement < ConsumptionRequirement < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

MarkedAs

MarkedAsEnumeration

1: 1

Specifies the status for an ACCESS RIGHT IN PRODUCT

Allowed values:

  • unused

  • used

  • marked

  • activated

  • expired

element

MarkedAsTemporalValidity

MarkedAsTemporalValidityEnumeration

1: 1

Specifies the temporal aspects of a CONSUMPTION REQUIREMENT

Allowed values:

  • current

  • future

  • currentFuture

  • any

  • expired

element

AccessRightInProductRef

AccessRightInProductRef

1: 1

Reference to the related ACCESS RIGHT IN PRODUCT

element

AccessNumber

xsd:integer

0: 1

Access number status (value) for this specific requirement.

...

CustomerPurchasePackageElementConsumptionRequirement < ConsumptionRequirement < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

MarkedAs

MarkedAsEnumeration

1: 1

Specifies the status for a CUSTOMER PURCHASE PACKAGE

Allowed values:

  • unused

  • used

  • marked

  • activated

  • expired

element

MarkedAsTemporalValidity

MarkedAsTemporalValidityEnumeration

1: 1

Specifies the temporal aspects of a CONSUMPTION REQUIREMENT

Allowed values:

  • current

  • future

  • currentFuture

  • any

  • expired

element

CustomerPurchasePackageElementRef

CustomerPurchasePackageElementRef

1: 1

Reference to the related CUSTOMER PURCHASE PACKAGE

...

Info

The definition of a CONSUMPTION specifying which ELEMENT and how it is to be processed

Example can be found in the official GitHub-repository for Entur

ElementConsumption < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

(choice) element

ConsumptionRequirement

AccessRightInProductConsumption

1: *

The definition of a CONSUMPTION UTILISATION defining which ACCESS RIGHT IN PRODUCT that is to be processed

CustomerPurchasePackageElementConsumption

The definition of a CONSUMPTION defining which CUSTOMER PURCHASE PACKAGE ELEMENT that is to be processed

...

AccessRightInProductConsumption < ElementConsumption < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

FromMarkedAs

MarkedAsEnumeration

1: 1

Specifies the from MarkedAs status for an ACCESS RIGHT IN PRODUCT

Allowed values:

  • unused

  • used

  • marked

  • activated

  • expired

element

ToMarkedAs

MarkedAsEnumeration

1: 1

Specifies the to MarkedAs status for an ACCESS RIGHT IN PRODUCT

Allowed values:

  • unused

  • used

  • marked

  • activated

  • expired

element

AccessRightInProductRef

AccessRightInProductRef

1: 1

Reference to the related ACCESS RIGHT IN PRODUCT

element

AccessNumber

xsd:integer

0: 1

Access number (value) for this specific consumption

element

specificationPolicyAssignmentInputs

PolicyAssignmentInput

0: 1

Input for ACCESS RIGHT IN PRODUCT specification policy assignment

TODO: Proof-of-concept to be finalized before NeTEx Change Request

...

CustomerPurchasePackageElementConsumption < ElementConsumption < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

FromMarkedAs

MarkedAsEnumeration

1: 1

Specifies the from MarkedAs status for a CUSTOMER PURCHASE PACKAGE

Allowed values:

  • unused

  • used

  • marked

  • activated

  • expired

element

ToMarkedAs

MarkedAsEnumeration

1: 1

Specifies the to MarkedAs status for a CUSTOMER PURCHASE PACKAGE

Allowed values:

  • unused

  • used

  • marked

  • activated

  • expired

element

CustomerPurchasePackageElementRef

CustomerPurchasePackageElementRef

1: 1

Reference to the related CUSTOMER PURCHASE PACKAGE

...

Info

Type for CROSS CONSTRAINT defining constraints for parameter selection across ELEMENTs

CrossConstraint < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Constraint

EntitlementConstraintStructure

1: 1

Entitlement constraints related PRODUCT or OFFER.

element

validityParameterAssignments

ValidityParameterAssignmentRef

0: *

Reference to VALIDITY PARAMETER ASSIGNMENTs associated with the SALES OFFER PACKAGE ELEMENT

...

PolicyAssignmentInput

XML-type

Name

Datatype

Cardinality

Description

(choice) element

AccessRightInProductSpecificationStartTimePolicyAssignmentInput

AccessRightInProductSpecificationStartTimePolicyAssignmentInput

1: *

Policy assignemtn input type for specifying a start time to an ACCESS RIGHT IN PRODUCT

TODO: Add further variants in NeTEx

not yet added to NeTEx

valg av avgang, sone osv

AccessRightInProductSpecificationStartTimePolicyAssignmentInput

...

PolicyAssignmentInput

XML-type

Name

Datatype

Cardinality

Description

element

AccessRightInProductRef

AccessRightInProductRef

1: 1

Reference to the ACCESS RIGHT IN PRODUCT for which to specify the start time policy

element

GenericParameterAssignmentRef

GenericParameterAssignmentRef

1: 1

Reference to the GENERIC PARAMETER ASSIGNMENT which specifies the start time requirement

element

RelativeTo

RelativeToEnumeration

1: 1

Relativivity to latest ELEMENT ACCESS for the referenced ACCESS RIGHT IN PRODUCT

Allowed values:

  • startOfValidity

  • endOfValidity

  • TODO: add relevant enumerations for other use-cases

element

TimeIntervalRef

TimeIntervalRef

1: 1

Reference to the relative time interval at which the assigned policy should take effect

Default is after, i.e. the time interval must be prefixed with minus ('-') for policies taking effect before PolicyAssignmentInput occurs

...

SalesOfferPackageElement < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

RequiresValidation

xsd:boolean

0: 1

Whether element requires validation before it can be used

element

ConditionSummary

ConditionSummary

0: 1

Summary description of SALES OFFER PACKAGE ELEMENT properties

element

SalesOfferPackageRef

SalesOfferPackageRef

1: 1 (ikke implementert som mandatory)

Reference to a SALES OFFER PACKAGE of which this is part. If not given by containing context must be specified.

KOMMENTAR: Sannsynligvis bedre med embedding enn referanse, dvs SalesOfferPackage inkluderer sine elements?

element

TypeOfTravelDocumenRef

TypeOfTravelDocumenRef

0: 1

Reference to a TYPE OF TRAVEL DOCUMENT.

element

FareProductRef

FareProductRef

0: 1

FARE PRODUCT associated with this SALES OFFER PACKAGE

element

validityParameterAssignments

GenericParameterAssignment

0: *

GENERIC PARAMETER ASSIGNMENTs associated with the SALES OFFER PACKAGE ELEMENT

element

prices

SalesOfferPackagePriceRef

0: *

SALES OFFER PACKAGE PRICEs associated with the SALES OFFER PACKAGE ELEMENT

...

Info

Information on the preferred substitution of packages with other package if quota restricted product is no longer available. The relative priority is specified using the order attribute inherited from ASSIGNMENT.

Example can be found in the official GitHub-repository for Entur

KOMMENTAR (se også over) - Anbefaler som del av objektet fremfor eksternt definert (i FareFrame) med referanse, siden dette (sannsynligvis) vil være unikt per SalesOfferPackage

SalesOfferPackageSubstitution <Assignment< DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SalesOfferPackageRef

SalesOfferPackageRef

0: 1

First SALES OFFER PACKAGE in combination.

If not given by containing context then this reference must be specified.

element

WithSalesOfferPackageRef

SalesOfferPackageRef

1: 1

Second SALES OFFER PACKAGE in combination.

...

Info

A set of reusable Pricing Parameters directing the rounding of values that are the result of calculations.

Example can be found in the official GitHub-repository for Entur

PricingParameterSet < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

pricingServices

PricingService

1: *

PRICING SERVICEs available to use.

...

Info

A web service used to provide prices dynamically at time of booking or purchase.

Example can be found in the official GitHub-repository for Entur

PricingService < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Name

MultilingualString

0: 1

Name of PRICING SERVICE.

element

Description

MultilingualString

0: 1

Description of PRICING SERVICE.

element

OrganisationRef

OrganisationRef

0: 1

Reference to ORGANISATION that provides the PRICING SERVICE.

element

Url

xsd:anyURI

1: 1

URL at which PRICING SERVICE is available.

...

Info

A set of all possible price features of a GEOGRAPHICAL UNIT: default total price etc.

GeographicalUnitPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

GeographicalUnitPrice inherits from FarePrice without introducing new elements or attributes.

...

GeographicalIntervalPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

GeographicalIntervalPrice inherits from FarePrice without introducing new elements or attributes.

...

QualityStructureFactorPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

QualityStructureFactorPrice inherits from FarePrice without introducing new elements or attributes.

...

DistanceMatrixElementPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

DistanceMatrixElementPrice inherits from FarePrice without introducing new elements or attributes.

...

FareStructureElementPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FareStructureElementPrice inherits from FarePrice without introducing new elements or attributes.

UsageParameterPrice

Info

A set of all possible price features of a USAGE PARAMETER: discount in value or percentage etc.

Example can be found in the official GitHub-repository for Entur

UsageParameterPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

UsageParameterPrice inherits from FarePrice without introducing new elements or attributes.

FareProductPrice

Info

A set of all possible price features of a FARE PRODUCT: default total price, discount in value or percentage etc.

Example can be found in the official GitHub-repository for Entur

FareProductPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FareProductPrice inherits from FarePrice without introducing new elements or attributes.

FulfilmentMethodPrice

Info

A set of all possible price features of a FULFILMENT METHOD, default total price etc.

Example can be found in the official GitHub-repository for Entur

FulfilmentMethodPrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FulfilmentMethodPrice inherits from FarePrice without introducing new elements or attributes.

SalesOfferPackagePrice

Info

A set of all possible price features of a SALES OFFER PACKAGE: default total price etc.

Example can be found in the official GitHub-repository for Entur

SalesOfferPackagePrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

SalesOfferPackagePrice inherits from FarePrice without introducing new elements or attributes.


PriceGroup

Warning

TODO: Recommended to remove, unless deemed strictly necessary
If removed, also remove the container from https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/728727624/framework#FareFrame

Info

A grouping of prices, allowing the grouping of numerous possible consumption elements into a limited number of price references, or to apply grouped increases, in value or percentage.

Example can be found in the official GitHub-repository for Entur

PriceGroup <GroupOfEntities<DataManagedObject< EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Amount

xsd:decimal

0: 1

Price in a specified currency

element

Currency

xsd:NMTOKEN (3 letters)

0: 1

ISO 4717 type currency code (optimization to allow PRICE UNITs to be omitted)

element

PricingRuleRef

PricingRuleRef

0: 1

Reference to a PRICING RULE used in calculation step to derive price

...

Info

A grouping of prices that may be associated with various combinations fare elements such as the DISTANCE MATRIX ELEMENT, FARE STRUCTURE ELEMENT, GEOGRAPHICAL INTERVAL, TIME INTERVAL, USAGE PARAMETER, etc.

Example can be found in the official GitHub-repository for Entur

FareTable < PriceGroup < GroupOfEntities < DataManagedObject < EntityInVersion < Entity (NB: Ikke implementert slik, i XSD arver FareTable direkte fra GroupOfEntities)

XML-type

Name

Datatype

Cardinality

Description

element

StartDate

xsd:date

0: 1

Start date for PRICE validity

element

EndDate

xsd:date

0: 1

End date for PRICE validity. Kommentar: Gyldighet bør heller angis med ValidityCondition for objektet

element

RoundingRef

RoundingRef

0: 1

Reference to a ROUNDING to use on calculation

element

pricesFor

PriceableObjectRef

0: *

Combination of Elements for which this table provides PRICEs

(choice) element

usedIn

TariffRef

0: *

Elements that use FARE TABLE that are not PRICEABLE OBJECTs

GroupOfDistanceMatrixElementsRef

GroupOfSalesOfferPackagesRef

element

OrganisationRef

OrganisationRef

0: *

Reference to a ORGANISATION for which this table applies

element

limitations

UsageParameterRef

0: *

Usage parameters common to all cells in table

element

prices

FarePrice

0: *

Simple FARE PRICE cells (optimised, without additional associations)

...

Info

An unique individual combination of features within a FARE TABLE, used to associate a FARE PRICE with a fare element.

Example can be found in the official GitHub-repository for Entur

Cell <VersionedChild<EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

attribute

order

xsd:integer

1: 1

>Order in which cell is to appear

element

FareStructureElementPriceRef

FareStructureElementPriceRef

0: *

Reference to a FARE STRUCTURE ELEMENT PRICE

...

Info

A type of outlet for selling a product.

Example can be found in the official GitHub-repository for Entur

DistributionChannel < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

alternativeNames

AlternativeName

0: *

List for alternative name(s) for Distribution Channel

(choice) element

DistributionChannelType

DistributionChannelTypeEnumeration

1: 1

Classification of DISTRIBUTION CHANNEL

Allowed values:

  • atStop

  • onBoard

  • online

  • telephone

  • electronicPass

  • postal

  • mobileDevice

  • agency

  • tourOperator

AllDistributionChannelsRef

AllDistributionChannelsRefStructureElement

Always "All"

element

IsObligatory

xsd:boolean

0: 1

Whether use of the channel is obligatory

element

RequiresEmailAddress

xsd:boolean

0: 1

Whether use of the channel requries the pruchaser to have an email address

(choice) element

ContactDetails

ContactStructure

0: 1

Contact details for distribution channel

OrganisationRef

OrganisationRef

Reference to Organisation responsible for Distribution Channel

element

PaymentMethods

PaymentMethodEnumeration

0: 1

Available payment methods

Allowed values:

  • cash

  • cashAndCard

  • coin

  • banknote

  • cheque

  • travellersCheque

  • postalOrder

  • companyCheque

  • creditCard

  • debitCard

  • cardsOnly

  • travelCard

  • contactlessPaymentCard

  • contactlessTravelCard

  • sms

  • mobilePhone

  • voucher

  • token

  • warrant

element

DistributionRights

DistributionRightsEnumeration

0: 1

Channels DISTRIBUTION RIGHTs

Allowed values:

  • none

  • sell

  • exchange

  • refund

  • inform

  • private

element

distributionPoints

PointRef

0: 1

List of references to a POINT (e.g. for info on geolocation)

element

DistributionGroupRef

DistributionGroupRef

0: 1

Prefined Group of specified points to which distribution is restricted, if any.

KOMMENTAR: Gruppering bør gjøres gjennom GroupOfDistributionChannels, ikke motsatt vei.

...

GroupOfDistributionChannels < GroupOfEntities < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

members

DistributionChannelRefs

1: 1

List containing minimum two or more DistributionChannelRef for group

...

Info

The means by which the ticket is delivered to the Customer.

Example can be found in the official GitHub-repository for Entur

FulfilmentMethod < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

FulfilmentMethodType

FulfilmentMethodTypeEnumeration

0: 1

Type of FULFILMENT METHOD

Allowed values:

  • ticketOffice

  • ticketMachine

  • conductor

  • agent

  • post

  • selfprint

  • sms

  • email

  • topUpDevice

  • validator

  • mobileApp

element

RequiresCard

xsd:boolean

0: 1

Whether use of of the method requires a credit or debit card

element

RequiresBookingReference

xsd:boolean

0: 1

Whether use of of the method requires a booking reference

element

typesOfTravelDocument

TypeOfTravelDocumentRef

0: *

List of TYPES OF TRAVEL DOCUMENT associated with method

element

canIssueTypesOfTravelDocument

TypeOfTravelDocumentRef

0: *

List of TYPES OF TRAVEL DOCUMENT that can be ISSUED with method

element

canReuseTypesOfTravelDocument

TypeOfTravelDocumentRef

0: *

TYPES OF TRAVEL DOCUMENT that can be REUSED with method

element

prices

FulfilmentMethodPriceRef

0: *

Reference to a FULFILMENT METHOD PRICE

...

Info

A classification of TRAVEL DOCUMENTs expressing their general function and local functional characteristics specific to the operator

Example can be found in the official GitHub-repository for Entur

TypeOfTravelDocument < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

IsCard

xsd:boolean

0: 1

Whether the TRAVEL DOCUMENT is materialised as a card

element

IsSmart

xsd:boolean

0: 1

Whether the TRAVEL DOCUMENT is materialized on a smart card or mobile device

element

HasPhoto

xsd:boolean

0: 1

Whether the TRAVEL DOCUMENT has a photo

element

MediaType

MediaTypeEnumeration

0: 1

Classification of the TRAVEL DOCUMENT by Media Type

Allowed values:

  • paperTicket

  • paperTicketWithCoupons

  • coupon

  • selfPrintPaperTicket

  • smartCard

  • mobileApp

  • card

  • mms

  • sms

element

MachineReadable

MachineReadableEnumeration

0: 1

Classification of the TRAVEL DOCUMENT by Machine Readable mechanism

Allowed values:

  • magneticStrip

  • chip

  • ocr

  • barCode

  • qrcode

  • nfc

  • shotCode (NB: Only as temporary replacement for QRcode)

...

Info

An assignment of the COUNTRY and/or DISTRIBUTION CHANNEL through which a product may or may not be distributed

DistributionAssignment < Assignment < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ServiceAccessRightRef

ServiceAccessRightRef

0: 1

Reference to a SERVICE ACCESS RIGHT

COMMENT - Rather referenced through PreassignedFareProduct of SalesOfferPackageElement

(choice) element

SalesOfferPackageRef

SalesOfferPackageRef

0: 1

Reference to a SALES OFFER PACKAGE

GroupOfSalesOfferPackagesRef

GroupOfSalesOfferPackagesRef

Reference to a GROUP OF SALES OFFER PACKAGEs

element

DistributionRights

DistributionRightsEnumeration

0: 1

List of values for DISTRIBUTION RIGHTs

Allowed values:

  • none

  • sell

  • exchange

  • refund

  • inform

  • private

element

DistributionChannelType

DistributionChannelTypeEnumeration

0: 1

Classification of DISTRIBUTION CHANNEL

Allowed values:

  • atStop

  • onBoard

  • online

  • telephone

  • electronicPass

  • postal

  • mobileDevice

  • agency

  • tourOperator

element

AllowedInChannel

xsd:boolean

0: 1

Whether distribution is allowed or forbidden for given channel

element

RestrictedToChannel

xsd:boolean

0: 1

Whether distribution is restricted to a given country and / or channel

element

MandatoryProduct

xsd:boolean

0: 1

Whether product is mandatory, i.e. must be provided

element

TicketingServiceFacilityList

TicketingServiceFacilityEnumeration

0: 1

List of TICKETING SERVICE FACILITies

Allowed values:

  • purchase

  • collection

  • cardTopUp

  • reservations

  • exchange

  • refund

  • renewal

  • excessFares

  • all

element

PaymentMethods


0: 1

Payment methods

Allowed values:

  • cash

  • cashAndCard

  • coin

  • banknote

  • cheque

  • travellersCheque

  • postalOrder

  • companyCheque

  • creditCard

  • debitCard

  • cardsOnly

  • travelCard

  • contactlessPaymentCard

  • contactlessTravelCard

  • sms

  • mobilePhone

  • voucher

  • token

  • warrant

element

RequiresRegistration

xsd:boolean

0: 1

Whether distribution requires registered user

element

FulfilmentMethodRef

FulfilmentMethodRef

0: 1

Reference to a FULFILMENT METHOD

...

GroupOfDistributionAssignments < GroupOfEntities < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

members

DistributionAssignmentRefs

2: *

List containing minimum two or more DistributionAssignmentRef for group

...

TypeOfAccessRightAssignment < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ActivationPolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing how and when to activate a validable element, generates CPPElementAccess with MarkedAs=activated

Usage:

Transition from MarkedAs=unused to MarkedAs=activated

COD:TypeOfAccessRightAssignment:ActivationPolicyAssignment

Must be used with a corresponding COD:TypeOfAccessRightAssignment:UsagePolicyAssignment

element

ActivationAssignment

TypeOfAccessRightAssignment

0: *

Rule describing limitations and parameters applicable when the validable element is activated (but not consumed)

Usage:

Transition from MarkedAs=unused to MarkedAs=activated

COD:TypeOfAccessRightAssignment:ActivationAssignment

element

UsagePolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing how to consume a validable element, generates CPPElementAccess with MarkedAs=used (the prerequisite is that the validable element is already MarkedAs=activated)

Usage:

Transition from MarkedAs=activated to MarkedAs=used

COD:TypeOfAccessRightAssignment:UsagePolicyAssignment

element

UsageAssignment

TypeOfAccessRightAssignment

0: *

Rule describing limitations and parameters applicable when the ValidableElement is used, i.e. the acquired travel rights

Usage:

Transition from MarkedAs=activated to MarkedAs=used

COD:TypeOfAccessRightAssignment:UsageAssignment

element

ActivationAndUsagePolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing how to both activate and consume in the same operation, generates CPPElementAccess with MarkedAs=used directly (omits MarkedAs=activated)

Usage:

Transition directly from MarkedAs=unused to MarkedAs=used (This can be seen as a rule combining Activation(Policy)Assignment and Usage(Policy)Assignment when separate activation and usage is not required)

COD:TypeOfAccessRightAssignment:ActivationAndUsagePolicyAssignment

element

ActivationAndUsageAssignment

TypeOfAccessRightAssignment

0: *

Rule describing limitations and parameters applicable when the ValidableElement is both activated and used in the same operation, i.e. the aquired travel rights

Usage:

Transition directly from MarkedAs=unused to MarkedAs=used (This can be seen as a rule combining Activation(Policy)Assignment and Usage(Policy)Assignment when separate activation and usage is not required)

COD:TypeOfAccessRightAssignment:ActivationAndUsageAssignment

element

RevalidationPolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing how and when to re-validate a validable element, generates CPPElementAccess with MarkedAs=marked

Usage:

Requirements for retransition from MarkedAs=used to MarkedAs=marked

COD:TypeOfAccessRightAssignment:RevalidationPolicyAssignment

...

TypeOfAccessRightAssignment < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SpecificationServiceJourneyPolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing that a ServiceJourney must be specified during activation or consumption or revalidation

Usage:

COD:TypeOfAccessRightAssignment:SpecificationServiceJourneyPolicyAssignment

element

SpecificationSeatPolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing that a PassengerSeat must be specified during activation or consumption or revalidation

Usage:

COD:TypeOfAccessRightAssignment:SpecificationSeatPolicyAssignment

element

SpecificationTariffZonePolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing that a TariffZone must be specified during activation or consumption or revalidation

Usage:

COD:TypeOfAccessRightAssignment:SpecificationTariffZonePolicyAssignment

element

SpecificationStartTimePolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing that a StartTime must be specified during activation or consumption or revalidation

Usage:

COD:TypeOfAccessRightAssignment:SpecificationStartTimePolicyAssignment

...

TypeOfAccessRightAssignment < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ExecutionTimePolicyAssignment

TypeOfAccessRightAssignment

0: *

Rule describing when a usage validity period may be activated or consumed, used as a subrule to either of:

  • COD:TypeOfAccessRightAssignment:ActivationAndUsagePolicyAssignment

  • COD:TypeOfAccessRightAssignment:ActivationPolicyAssignment

  • COD:TypeOfAccessRightAssignment:UsagePolicyAssignment

Usage:

COD:TypeOfAccessRightAssignment:ExecutionTimePolicyAssignment

...

TypeOfAccessRightAssignment < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CommonAssignment

TypeOfAccessRightAssignment

0: *

Assignment describing common parameters applicable to all xxxPolicyAssignment and xxxAssignment

Usage:

COD:TypeOfAccessRightAssignment:CommonAssignment

...

TypeOfAccessRightAssignment < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SpecificationAssignment

TypeOfAccessRightAssignment

0: *

Rule describing specified access rights as a result of activation or consumption or revalidation, e.g. specified (selected) service journey or seat

Usage:

COD:TypeOfAccessRightAssignment:SpecificationAssignment

...

TypeOfAccessRightAssignment < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

AccessLogDetails

TypeOfAccessRightAssignment

0: *

CPPAccess with information about an activation / consumption / re-validation

Usage:

COD:TypeOfAccessRightAssignment:AccessLogDetails

...

Info

Predefined TYPE OF CUSTOMER ACCOUNTs for ID based ticketing

TypeOfCustomerAccount < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Ordinary

TypeOfCustomerAccount

0: *

Ordinary account based ticketing account

Usage:

COD:TypeOfCustomerAccount:Ordinary

element

PhysicalMediaAuditAccount

TypeOfCustomerAccount

0: *

Audit account for storing results from inspection of tickets on physical media.

NB: Read only after creation.

Usage:

COD:TypeOfCustomerAccount:PhysicalMediaAuditAccount

...

Info

Predefined TYPE OF FARE CONTRACTSs for use with ID based ticketing systems

TypeOfFareContract < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Ordinary

TypeOfFareContract

0: *

Ordinary fare contract for account based ticketing

Usage:

COD:TypeOfFareContract:Ordinary

element

OrdinaryV2

TypeOfFareContract

0: *

Ordinary fare contract for account based ticketing. Version 2 with new consumption modelling.

Usage:

COD:TypeOfFareContract:OrdinaryV2

element

PhysicalMediaAuditFareContract

TypeOfFareContract

0: *

Audit copy of access rights stored on physical media. Will be created as a read only fare contract on a PhysicalMediaAuditAccount.

Usage:

COD:TypeOfFareContract:PhysicalMediaAuditFareContract

element

PhysicalMediaAuditFareContractV2

TypeOfFareContract

0: *

Audit copy of access rights stored on physical media. Will be created as a read only fare contract on a PhysicalMediaAuditAccount. Version 2 with new consumption modelling.

Usage:

COD:TypeOfFareContract:PhysicalMediaAuditFareContractV2

...

Info

Predefined TYPE OF RESPONSIBILITY ROLEs

TypeOfResponsibilityRole < TypeOfEntity < TypeOfValue < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Conductor

TypeOfResponsibilityRole

0: *

Type of responsibility role for conductor

Usage:

COD:TypeOfResponsibilityRole:Conductor

element

CustomerService

TypeOfResponsibilityRole

0: *

Type of responsibility role for customer service

Usage:

COD:TypeOfResponsibilityRole:CustomerService

element

SelfService

TypeOfResponsibilityRole

0: *

Type of responsibility role for self service

Usage:

COD:TypeOfResponsibilityRole:SelfService

...