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 sales 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 customer, retail, consumption control and sales transaction 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 the presentation of fare information to the travelling 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

Customer

Customer

...

CustomerAccount < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Name

MultilingualString

1: 1

Name of CUSTOMER (ACCOUNT)

element

Description

MultilingualString

0: 1

Description of CUSTOMER ACCOUNT

element

StartDate

xsd:dateTime

0: 1

Creation date of CUSTOMER ACCOUNT

element

EndDate

xsd:dateTime

0: 1

Termination/deletion date of CUSTOMER ACCOUNT

element

CustomerRef

CustomerRef

1: 1

Reference to CUSTOMER that holds account

element

TypeOfCustomerAccountRef

TypeOfCustomerAccount

1: 1

Type of CUSTOMER ACCOUNT

element

CustomerAccountStatusRef

CustomerAccountStatus

0: 1

Status of a CUSTOMER ACCOUNT

element

CustomerAccountStatusType

CustomerAccountStatusTypeEnum

1: 1

Allowed values:

  • unused

  • active

  • dormant

  • suspended

  • archived

  • closed

element

fareContracts

FareContractRef

0: *

FARE CONTRACTs for CUSTOMER ACCOUNT

TODO - Bør trolig spesifiseres at enten skal CustomerAccount ha relevante FareContractRefs eller (mindre aktuelt?) så bør FareContract ha relevante CustomerAccountRef - ikke begge deler

element

customerPurchasePackages

CustomerPurchasePackageRef

0: 1

Reference(s) to CUSTOMER PURCHASE PACKAGE(s) for the CUSTOMER ACCOUNT

element

customerAccountEntries

CustomerAccountEntry

0: *

LOG ENTRIES for CUSTOMER ACCOUNT.

element

customerPurchasePackages

CustomerPurchasePackage

0: 1

CUSTOMER PURCHASE PACKAGEs for the CUSTOMER ACCOUNT

...

Info

An abstract parameter type for a CUSTOMER ACCOUNT LOG ENTRY.

CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

IsValid

xsd:boolean

0: 1

Whether CUSTOMER ACCOUNT ENTRY is valid.

element

TypeOfCustomerAccountEntryRef

TypeOfCustomerAccountEntryRef

0: 1

Classification of the CUSTOMER ACCOUNT ENTRY.

Note: If to be used - in addition to its classification given by the Entry subtype - the TypeOfCustomerAccountEntry should be defined as a (per profile) fixed ValueSet within the ResourceFrame to explicitly classify/group LOG ENTRIES for a Customer Account, rather than being (de facto) an unclassified reference.

element

CustomerAccountRef

CustomerAccountRef

0: 1

Reference to the CUSTOMER ACCOUNT for which this is a LOG ENTRY.

Recommended to have containment of the CustomerAccountEntries within a CUSTOMER ACCOUNT, i.e. preferably not referencing (backwards) to the CUSTOMER ACCOUNT within its LOG ENTRY(s)

...

Info

A CUSTOMER REGISTRATION entry records the registering of a CUSTOMER with the creation of a CUSTOMER ACCOUNT.

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

CustomerRegistration < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerRegistration inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A CUSTOMER DEREGISTRATION entry records the clearing of all personal details of a CUSTOMER and the closing of a CUSTOMER ACCOUNT.

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

CustomerDeregistration < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerDeregistration inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A NO ACCESS RIGHTS ON ACCOUNT ENTRY records the detection of a passenger without a valid ticket (i.e. no SERVICE ACCESS RIGHT on the CUSTOMER ACCOUNT).

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

NoAccessRightsOnAccount < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

StopPlaceRef

StopPlaceRef

1: 1

StopPlace where activitiy leading to event happened.

element

ServiceJourneyRef

ServiceJourneyRef

1: 1

ServiceJourney where activitiy leading to event happened.

element

DistanceMatrixElementRef

DistanceMatrixElementRef

1: 1

DistanceMatrixElement where activitiy leading to event happened.

...

InsufficientAccessRightsOnAccount < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

StopPlaceRef

StopPlaceRef

1: 1

StopPlace where activitiy leading to event happened.

element

ServiceJourneyRef

ServiceJourneyRef

1: 1

ServiceJourney where activitiy leading to event happened.

element

DistanceMatrixElementRef

DistanceMatrixElementRef

1: 1

DistanceMatrixElement where activitiy leading to event happened.

...

Info

A PassengerValidateTravel entry records the re-validation of a VALIDABLE ELEMENTs for a passenger with a CUSTOMER ACCOUNT.

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

PassengerValidateTravel < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

PassengerValidateTravel inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A PassengerUsedSameStop entry records the disallowed attempt to re-validation of a VALIDABLE ELEMENTs on a previously validated STOP POINT for a passenger with a CUSTOMER ACCOUNT.

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

PassengerUsedSameStop < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

PassengerUsedSameStop inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TokenTravelDocumentRegistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

TokenTravelDocumentRegistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TokenTravelDocumentObtainedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

TokenTravelDocumentObtainedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TokenTravelDocumentDeregistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

TokenTravelDocumentDeregistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerAccountInspectedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerAccountInspectedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerAccountBlockedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerAccountBlockedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerAccountUnblockedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerAccountUnblockedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerProfileModificationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerProfileModificationEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TokenTravelDocumentTransferInitiatedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

TokenTravelDocumentTransferInitiatedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TokenTravelDocumentTransferAcceptedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

TokenTravelDocumentTransferAcceptedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TokenTravelDocumentTransferRejectedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

TokenTravelDocumentTransferRejectedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TransferAllFareContractsInitiatedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ToCustomerAccountRef

CustomerAccountRef

0: 1

Reference to the CUSTOMER ACCOUNT to which FARE CONTRACTs will be transferred

TransferAllFareContractsInitiatedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TransferAllFareContractsReceivedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

FromCustomerAccountRef

CustomerAccountRef

0: 1

Reference to the CUSTOMER ACCOUNT from which FARE CONTRACTs are transferred

TransferAllFareContractsReceivedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

TransferAllFareContractsCompletedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

TransferAllFareContractsCompletedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerAccountMinimumSecurityLevelUpdatedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerAccountMinimumSecurityLevelUpdatedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

SecurityRiskVerificationRegistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

SecurityRiskVerificationRegistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

SecurityRiskVerificationDeregistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

SecurityRiskVerificationDeregistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

FareContract < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Name

MultilingualString

1: 1

Name of FARE CONTRACT

element

Description

MultilingualString

0: 1

Description of FARE CONTRACT

element

StartDate

xsd:dateTime

0: 1

Start date of FARE CONTRACT

Calculated per consuprofilemed or consumable ValidableElement

element

EndDate

xsd:dateTime

0: 1

End date of FARE CONTRACT

Calculated per consumed or consumable ValidableElement

element

Status

xsd:normalizedString

0: 1

Status of FARE CONTRACT

(choice)
element

CustomerRef

CustomerRef

0: 1

Reference to the CUSTOMER for the FARE CONTRACT

Only contain when anonymous Customer object. For known Customer, use CustomerAccountRef.

CustomerAccountRef

CustomerAccount

Reference to the CUSTOMER ACCOUNT associated with the FARE CONTRACT

TODO - Bør trolig spesifiseres at enten skal CustomerAccount ha relevante FareContractRefs eller (mindre aktuelt?) så bør FareContract ha relevante CustomerAccountRef - ikke begge deler

element

TypeOfFareContractRef

TypeOfFareContract

0: 1

Type of FARE CONTRACT

element

fareContractEntries

FareContractEntry

0: *

FARE CONTRACT ENTRies making up the FARE CONTRACT

Normally, a TravelSpecification should be presented as part of the SalesTransaction, however if a SalesTransaction is not relevant in the current SalesTransactionFrame, the TravelSpecification may be modeled directly on the FareContract

...

Info

An abstract type to record an event occurring in the life of a FARE CONTRACT: initial contracting, sales, validation entries, etc. A subset of a FARE CONTRACT ENTRY is often materialised on a TRAVEL DOCUMENT (e.g. SalesTransaction) or TravelSpecification)

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

FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

IsValid

xsd:boolean

0: 1

Whether the FARE CONTRACT ENTRY is valid or not

element

TypeOfFareContractEntryRef

TypeOfFareContractEntryRef

0: 1

Classification of the FARE CONTRACT ENTRY.

Note: If to be used - in addition to its classification given by the Entry subtype - the TypeOfFareContractEntry should be defined as a (per profile) fixed ValueSet within the ResourceFrame to explicitly classify/group LOG ENTRIES for a Customer Account, rather than being (de facto) an unclassified reference.

element

FareContractRef

FareContractRef

0: 1

Reference to a FARE CONTRACT to which the FARE CONTRACT ENTRY applies.

Recommended to have containment of the FareConctractEntries within a FARE CONTRACT, i.e. preferably not referencing (backwards) to the FARE CONTRACT within its LOG ENTRY(s)

...

FareContractActivationEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FareContractActivationEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A FareContractCancelEntry records that a FARE CONTRACT has been marked as cancelled.

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

FareContractCancelEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FareContractCancelEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A FareContractRefundEntry records that a FARE CONTRACT has been marked as refunded.

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

FareContractRefundEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FareContractRefundEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerPurchasePackageTransferInitiatedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CustomerPurchasePackageRef

CustomerPurchasePackageRef

1: 1

Reference to related CUSTOMER PURCHASE PACKAGE (i.e. to be transferred)

CustomerPurchasePackageTransferInitiatedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerPurchasePackageTransferReceivedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CustomerPurchasePackageRef

CustomerPurchasePackageRef

1: 1

Reference to related CUSTOMER PURCHASE PACKAGE (i.e. to be received)

CustomerPurchasePackageTransferReceivedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerPurchasePackageTransferCompletedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerPurchasePackageTransferCompletedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerPurchasePackageTransferAbortedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerPurchasePackageTransferAbortedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerPurchasePackageAddedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CustomerPurchasePackageRef

CustomerPurchasePackageRef

1: 1

Reference to related CUSTOMER PURCHASE PACKAGE (i.e. to be added)

CustomerPurchasePackageAddedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerPurchasePackageReplacedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

ReplacedCustomerPurchasePackageRef

CustomerPurchasePackageRef

1: 1

Reference to CUSTOMER PURCHASE PACKAGE being replaced

element

ReplacmentCustomerPurchasePackageRef

CustomerPurchasePackageRef

1: 1

Reference to new CUSTOMER PURCHASE PACKAGE replacing the previous

CustomerPurchasePackageAddedEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

CustomerPurchasePackageWithdrawnEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

CustomerPurchasePackageRef

CustomerPurchasePackageRef

1: 1

Reference to related CUSTOMER PURCHASE PACKAGE (i.e. to be withdrawn)

CustomerPurchasePackageWithdrawnEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A FareContractConsumeEntry records that ACCESS RIGHT(s) on the CUSTOMER PURCHASE PACKAGE(s) for the related FARE CONTRACT is consumed.

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

FareContractConsumeEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FareContractConsumeEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

FareContractRevertConsumptionEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

FareContractRevertConsumptionEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A PurchaseFulfilmentEntry records the fulfilment of a FARE CONTRACT purchase.

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

PurchaseFulfilmentEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

PurchaseFulfilmentEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

PassengerValidateTravelEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

StopPlaceRef

StopPlaceRef

0: 1

Reference to STOP PLACE where activitiy leading to event happened.

element

QuayRef

QuayRef

0: 1

Reference to QUAY where activitiy leading to event happened.

element

ServiceJourneyRef

ServiceJourneyRef

0: 1

Reference to SERVICE JOURNEY where activitiy leading to event happened.

element

TicketValidatorEquipmentRef

TicketValidatorEquipmentRef

1: 1

Reference to TICKET VALIDATOR EQUIPMENT where activitiy was recorded.

PassengerValidateTravelEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

PassengerUsedSameStopEntryType < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

(choice) element

StopPlaceRef

StopPlaceRef

1: 1

Reference to STOP PLACE where activitiy leading to event happened.

QuayRef

QuayRef

Reference to QUAY where activitiy leading to event happened.

Quay can be assigned as supplementary information if StopPlaceRef is already provided

element

ServiceJourneyRef

ServiceJourneyRef

0: 1

Reference to SERVICE JOURNEY where activitiy leading to event happened.

element

TicketValidatorEquipmentRef

TicketValidatorEquipmentRef

1: 1

Reference to TICKET VALIDATOR EQUIPMENT where activitiy was recorded.

PassengerUsedSameStopEntryType inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A MappingFulfilmentEntry indicates all CUSTOMER PURCHASE PACKAGE(s) and CUSTOMER related information is currectly mapped for the FARE CONTRACT.

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

MappingFulfilmentEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

MappingFulfilmentEntry inherits from CustomerAccountEntry without introducing new elements or attributes.

...

Info

A SALE OF a FIXED PACKAGE or a SALE OF a RELOADABLE PACKAGE

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

SalesTransaction < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Date

xsd:dateTime

0: 1

Date of SALES TRANSACTION

element

Amount

CurrencyAmountType (xsd:decimal)

1: 1

Amount of SALES TRANSACTION

element

Currency

CurrencyType (xsd:NMTOKEN)

0: 1

ISO 4717 3-letter currency code

Defaults to local currency for the sales transaction system

element

PaymentMethod

PaymentMethodEnumeration

0: 1

Allowed values:

  • cash

  • cashAndCard

  • creditCard

  • debitCard

  • travelCard

  • sms

(choice) element(s)

travelSpecifications

TravelSpecificationRef

0: *

TRAVEL SPECIFICATIONs for SALES TRANSACTION

For generic presentation of a FareContract

RequestedTravelSpecificationRef

Requested TRAVEL SPECIFICATIONs for SALES TRANSACTION

For presentation of the requested FareContract

OfferedTravelSpecificationRef

Offered TRAVEL SPECIFICATIONs for SALES TRANSACTION

For presentation of the offered FareContract

element

customerPurchasePackages

CustomerPurchasePackage

0: *

CUSTOMER PURCHASE PACKAGEs bought by SALES TRANSACTION

...

Info

The recording of the specification by a customer of parameters giving details of an intended consumption (e.g. origin and destination of a travel).

Optional element that can be used by data providers for presenting fundamentals of a FareContract / SalesTransaction and its underlying limitations and validities to e.g. a FareContract holder

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

TravelSpecification < FareContractEntry < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Name

MultilingualString

1: 1

Name of TRAVEL SPECIFICATION

element

Description

MultilingualString

0: 1

Description of TRAVEL SPECIFICATION

element

Units

xsd:decimal

0: 1

Number of units

element

StartOfValidity

xsd:dateTime

0: 1

Start of validity of travel

element

EndOfValidity

xsd:dateTime

0: 1

End of validity of travel

element

specificParameterAssignments

SpecificParameterAssignment

1: *

SPECIFIC PARAMETER ASSIGNMENTs relating to TRAVEL SPECIFICATION

...

SpecificParameterAssignment < 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 SpecificParameterAssignments. 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

SpecificParameterAssignment

0: *

A list of VALIDITY PARAMETER ASSIGNMENT without ID constraing 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 particular physical support (ticket, card, etc.) to be held by a customer, allowing the right to travel or to consume joint-services, to proof a payment including possible discount rights), to store a subset of the CONTRACT liabilities or a combination of those.

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

TravelDocument < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

Name

MultilingualString

0: 1

Name of TRAVEL DOCUMENT

element

Description

MultilingualString

0: 1

Description of TRAVEL DOCUMENT

element

PrivateCode

xsd:normalizedString

0: 1

External identifier of TRAVEL DOCUMENT

element

TypeOfTravelDocumentRef

TypeOfTravelDocumentRef

0: 1

Reference to a TYPE OF TRAVEL DOCUMENT

element

CustomerPurchasePackageRef

CustomerPurchasePackageRef

0: 1

Reference to a CUSTOMER PURCHASE PACKAGE

element

MarkedAs

MarkedAsEnumeration

0: 1

Usage/marking status of TRAVEL DOCUMENT

Allowed values:

  • unused

  • activated

  • (marked)

  • used

  • expired

...

Info

A purchase of a SALES OFFER PACKAGE by a CUSTOMER, giving access rights to one or several FARE PRODUCTs materialised as one or several TRAVEL DOCUMENTs.

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

CustomerPurchasePackage < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SalesOfferPackageRef

SalesOfferPackage

1: 1

Reference to a SALES OFFER PACKAGE for which this is a purchase

(choice)
element

CustomerRef

CustomerRef

0: 1

Reference to the CUSTOMER associated with CUSTOMER PURCHASE PACKAGE

CustomerAccountRef

CustomerAccountRef

Reference to the CUSTOMER ACCOUNT associated with CUSTOMER PURCHASE PACKAGE

element

CustomerPurchasePackageStatus

CustomerPurchasePackageStatusEnumeration

0: 1

Status of CUSTOMER PURCHASE PACKAGE

Allowed values:

  • unused

  • ordered

  • reserved

  • paidFor

  • activated

  • partiallyUsed

  • used

  • archived

element

travelSpecifications

TravelSpecificationRef

0: *

TRAVEL SPECIFICATIONs for SALES TRANSACTION

For generic presentation of a CustomerPurchasePackage

REMARK - Technically, this can also be specific REQUESTED and/or OFFERED TravelSpecification(Ref)s, but such distinction is unlikely to be relevant for a CustomerPurchasePackage?

element

elementConsumptionPolicies

ElementConsumptionPolicy

0: *

List of CONSUMPTION UTILISATION DEPENDENCIES in CUSTOMER PURCHASE PACKAGE

element

customerPurchasePackageElements

CustomerPurchasePackageElement

1: *

CUSTOMER PURCHASE PACKAGE ELEMENTs associated with the CUSTOMER PURCHASE PACKAGE

(choice)
element

prices

CustomerPurchasePackagePrice

0: *

CUSTOMER PURCHASE PACKAGE PRICEs associated with the CUSTOMER PURCHASE PACKAGE

CustomerPurchasePackagePriceRef

Reference to a CUSTOMER PURCHASE PACKAGE PRICEs associated with the CUSTOMER PURCHASE PACKAGE

...

CustomerPurchasePackageElement < PriceableObject < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

SalesOfferPackageElementRef

SalesOfferPackageElement

1: 1

Reference to a SALES OFFER PACKAGE for which this is a purchase

element

elementAccesses

CustomerPurchasePackageElementAccess

1: *

CUSTOMER PURCHASE PACKAGE ELEMENT ACCESSes making up the CUSTOMER PURCHASE PACKAGE ELEMENT

element

validityParameterAssignments

CustomerPurchaseParameterAssignment

1: *

ACCESS RIGHT PARAMETER ASSIGNMENTs selected for the CUSTOMER PURCHASE PACKAGE ELEMENT

element

prices

CustomerPurchasePackageElementPrice

1: *

CUSTOMER PURCHASE PACKAGE ELEMENT PRICEs associated with the CUSTOMER PURCHASE PACKAGE ELEMENT

...

CustomerPurchasePackageElementAccess < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

(choice) element

ValidableElementRef

ValidableElementRef

1: 1

VALIDABLE ELEMENT associated with the CUSTOMER PURCHASE PACKAGE ELEMENT ACCESS

FareStructureElementRef

FareStructureElementRef

FARE STRUCTURE ELEMENT associated with the CUSTOMER PURCHASE PACKAGE ELEMENT ACCESS

element

MarkedAs

MarkedAsEnumeration

0: 1

Usage/marking status of CUSTOMER PURCHASE PACKAGE ELEMENT ACCESS

Allowed values:

  • unused

  • activated

  • (marked)

  • used

  • expired

element

validityParameterAssignments

CustomerPurchaseParameterAssignment

0: *

CUSTOMER PURCHASE PARAMETER ASSIGNMENTs selected for the CUSTOMER PURCHASE PACKAGE ELEMENT ACCESS

...

CustomerPurchaseParameterAssignment < ValidityParameterAssignment < AccessRightParameterAssignment < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

TypeOfAccessRightAssignmentRef

TypeOfAccessRightAssignmentRef

0: 1

Classification of ACCESS RIGHT PARAMETER ASSIGNMENT

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

(choice) element

includes

CustomerPurchaseParameterAssignment

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)

CustomerPurchaseParameterAssignmentRef

...

CustomerPurchasePackagePrice < FarePrice < VersionedChild < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

CustomerPurchasePackagePrice inherits from FarePrice without introducing new elements or attributes.

...