/
fares

fares

This page is under final revision, awaiting review approval and inclusion in the Nordic NeTEx Profile

Version

Current version for fares is:   v0.96  (last changed Jul 28, 2022)

Content



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 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

GeographicalUnit

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

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

GeographicalInterval

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

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

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

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

GeographicalStructureFactor < FareStructureFactor < PriceableObject < DataManagedObject < EntityInVersion < Entity

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

TimeInterval

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

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

QualityStructureFactor

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

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

FareDemandFactor

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

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.

StartTimeAtStopPoint

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

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.)

FareQuotaFactor

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

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.

 

DistanceMatrixElement

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

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