sales
This page is under final revision, awaiting review approval and inclusion in the Nordic NeTEx Profile
Version
Current version for sales is: v0.96 (last changed Jul 28, 2022)
Content
- 1 Components
- 1.1 Customer
- 1.1.1 Customer
- 1.1.2 CustomerAccount
- 1.1.3 Customer Account log entries
- 1.1.3.1 CustomerAccountEntry
- 1.1.3.2 CustomerRegistration
- 1.1.3.3 CustomerDeregistration
- 1.1.3.4 NoAccessRightsOnAccount
- 1.1.3.5 InsufficientAccessRightsOnAccount
- 1.1.3.6 PassengerValidateTravel
- 1.1.3.7 PassengerUsedSameStop
- 1.1.3.8 TokenTravelDocumentRegistrationEntry
- 1.1.3.9 TokenTravelDocumentObtainedEntry
- 1.1.3.10 TokenTravelDocumentDeregistrationEntry
- 1.1.3.11 CustomerAccountInspectedEntry
- 1.1.3.12 CustomerAccountBlockedEntry
- 1.1.3.13 CustomerAccountUnblockedEntry
- 1.1.3.14 CustomerProfileModificationEntry
- 1.1.3.15 TokenTravelDocumentTransferInitiatedEntry
- 1.1.3.16 TokenTravelDocumentTransferAcceptedEntry
- 1.1.3.17 TokenTravelDocumentTransferRejectedEntry
- 1.1.3.18 TransferAllFareContractsInitiatedEntry
- 1.1.3.19 TransferAllFareContractsReceivedEntry
- 1.1.3.20 TransferAllFareContractsCompletedEntry
- 1.1.3.21 CustomerAccountMinimumSecurityLevelUpdatedEntry
- 1.1.3.22 SecurityRiskVerificationRegistrationEntry
- 1.1.3.23 SecurityRiskVerificationDeregistrationEntry
- 1.2 Purchase
- 1.2.1 FareContract
- 1.2.2 Fare Contract log entries
- 1.2.2.1 FareContractEntry
- 1.2.2.2 FareContractActivationEntry
- 1.2.2.3 FareContractCancelEntry
- 1.2.2.4 FareContractRefundEntry
- 1.2.2.5 CustomerPurchasePackageTransferInitiatedEntry
- 1.2.2.6 CustomerPurchasePackageTransferReceivedEntry
- 1.2.2.7 CustomerPurchasePackageTransferCompletedEntry
- 1.2.2.8 CustomerPurchasePackageTransferAbortedEntry
- 1.2.2.9 CustomerPurchasePackageAddedEntry
- 1.2.2.10 CustomerPurchasePackageReplacedEntry
- 1.2.2.11 CustomerPurchasePackageWithdrawnEntry
- 1.2.2.12 FareContractConsumeEntry
- 1.2.2.13 FareContractRevertConsumptionEntry
- 1.2.2.14 PurchaseFulfilmentEntry
- 1.2.2.15 PassengerValidateTravelEntry
- 1.2.2.16 PassengerUsedSameStopEntryType
- 1.2.2.17 MappingFulfilmentEntry
- 1.2.3 SalesTransaction
- 1.2.4 TravelSpecification
- 1.2.5 SpecificParameterAssignment
- 1.2.6 TravelDocument
- 1.2.7 CustomerPurchasePackage
- 1.2.8 CustomerPurchasePackageElement
- 1.2.9 CustomerPurchasePackageElementAccess
- 1.2.10 CustomerPurchaseParameterAssignment
- 1.3 Prices
- 1.1 Customer
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
An identified person or organisation involved in a fare process. There may be a FARE CONTRACT between the CUSTOMER and the OPERATOR or the AUTHORITY ruling the consumption of services.
Example can be found in the official GitHub-repository for Entur
Customer < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | Surname | xsd:normalizedString | 0: 1 | Surname of a FARE CUSTOMER |
element | FirstName | xsd:normalizedString | 0: 1 | First name of CUSTOMER |
element | DateOfBirth | xsd:date | 0: 1 | Date of birth of CUSTOMER |
element | IdentityDocumentRef | PrivateCodeStructure (xsd:normalizedString) | 0: 1 | A document that identifies the CUSTOMER |
CustomerAccount
CustomerAccount < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | Name | 1: 1 | Name of CUSTOMER (ACCOUNT) | |
element | Description | 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 | 1: 1 | Reference to CUSTOMER that holds account | |
element | TypeOfCustomerAccountRef | 1: 1 | Type of CUSTOMER ACCOUNT | |
element | CustomerAccountStatusRef | 0: 1 | Status of a CUSTOMER ACCOUNT | |
element | CustomerAccountStatusType | CustomerAccountStatusTypeEnum | 1: 1 | Allowed values:
|
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 | 0: 1 | Reference(s) to CUSTOMER PURCHASE PACKAGE(s) for the CUSTOMER ACCOUNT | |
element | customerAccountEntries | 0: * | LOG ENTRIES for CUSTOMER ACCOUNT. | |
element | customerPurchasePackages | 0: 1 | CUSTOMER PURCHASE PACKAGEs for the CUSTOMER ACCOUNT |
Customer Account log entries
CustomerAccountEntry
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) |
CustomerRegistration
CustomerRegistration < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerRegistration inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerDeregistration
CustomerDeregistration < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerDeregistration inherits from CustomerAccountEntry without introducing new elements or attributes. |
NoAccessRightsOnAccount
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
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. |
PassengerValidateTravel
PassengerValidateTravel < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
PassengerValidateTravel inherits from CustomerAccountEntry without introducing new elements or attributes. |
PassengerUsedSameStop
PassengerUsedSameStop < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
PassengerUsedSameStop inherits from CustomerAccountEntry without introducing new elements or attributes. |
TokenTravelDocumentRegistrationEntry
TokenTravelDocumentRegistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
TokenTravelDocumentRegistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
TokenTravelDocumentObtainedEntry
TokenTravelDocumentObtainedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
TokenTravelDocumentObtainedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
TokenTravelDocumentDeregistrationEntry
TokenTravelDocumentDeregistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
TokenTravelDocumentDeregistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerAccountInspectedEntry
CustomerAccountInspectedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerAccountInspectedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerAccountBlockedEntry
CustomerAccountBlockedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerAccountBlockedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerAccountUnblockedEntry
CustomerAccountUnblockedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerAccountUnblockedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerProfileModificationEntry
CustomerProfileModificationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerProfileModificationEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
TokenTravelDocumentTransferInitiatedEntry
TokenTravelDocumentTransferInitiatedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
TokenTravelDocumentTransferInitiatedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
TokenTravelDocumentTransferAcceptedEntry
TokenTravelDocumentTransferAcceptedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
TokenTravelDocumentTransferAcceptedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
TokenTravelDocumentTransferRejectedEntry
TokenTravelDocumentTransferRejectedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
TokenTravelDocumentTransferRejectedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
TransferAllFareContractsInitiatedEntry
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
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
TransferAllFareContractsCompletedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
TransferAllFareContractsCompletedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerAccountMinimumSecurityLevelUpdatedEntry
CustomerAccountMinimumSecurityLevelUpdatedEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerAccountMinimumSecurityLevelUpdatedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
SecurityRiskVerificationRegistrationEntry
SecurityRiskVerificationRegistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
SecurityRiskVerificationRegistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
SecurityRiskVerificationDeregistrationEntry
SecurityRiskVerificationDeregistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
SecurityRiskVerificationDeregistrationEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
Purchase
FareContract
FareContract < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | Name | 1: 1 | Name of FARE CONTRACT | |
element | Description | 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) | CustomerRef | 0: 1 | Reference to the CUSTOMER for the FARE CONTRACT Only contain when anonymous Customer object. For known Customer, use CustomerAccountRef. | |
CustomerAccountRef | 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 | 0: 1 | Type of FARE CONTRACT | |
element | fareContractEntries | 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 |
Fare Contract log entries
FareContractEntry
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
FareContractActivationEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
FareContractActivationEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
FareContractCancelEntry
FareContractCancelEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
FareContractCancelEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
FareContractRefundEntry
FareContractRefundEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
FareContractRefundEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerPurchasePackageTransferInitiatedEntry
CustomerPurchasePackageTransferInitiatedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | 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
CustomerPurchasePackageTransferReceivedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | 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
CustomerPurchasePackageTransferCompletedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerPurchasePackageTransferCompletedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerPurchasePackageTransferAbortedEntry
CustomerPurchasePackageTransferAbortedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerPurchasePackageTransferAbortedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerPurchasePackageAddedEntry
CustomerPurchasePackageAddedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | 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
CustomerPurchasePackageReplacedEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | ReplacedCustomerPurchasePackageRef | 1: 1 | Reference to CUSTOMER PURCHASE PACKAGE being replaced | |
element | ReplacmentCustomerPurchasePackageRef | 1: 1 | Reference to new CUSTOMER PURCHASE PACKAGE replacing the previous | |
CustomerPurchasePackageAddedEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
CustomerPurchasePackageWithdrawnEntry
CustomerPurchasePackageWithdrawnEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | CustomerPurchasePackageRef | 1: 1 | Reference to related CUSTOMER PURCHASE PACKAGE (i.e. to be withdrawn) | |
CustomerPurchasePackageWithdrawnEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
FareContractConsumeEntry
FareContractConsumeEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
FareContractConsumeEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
FareContractRevertConsumptionEntry
FareContractRevertConsumptionEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
FareContractRevertConsumptionEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
PurchaseFulfilmentEntry
PurchaseFulfilmentEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
PurchaseFulfilmentEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
PassengerValidateTravelEntry
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
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. |
MappingFulfilmentEntry
MappingFulfilmentEntry < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
MappingFulfilmentEntry inherits from CustomerAccountEntry without introducing new elements or attributes. |
SalesTransaction
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:
|
(choice) element(s) | travelSpecifications | 0: * | TRAVEL SPECIFICATIONs for SALES TRANSACTION For generic presentation of a FareContract | |
Requested TRAVEL SPECIFICATIONs for SALES TRANSACTION For presentation of the requested FareContract | ||||
Offered TRAVEL SPECIFICATIONs for SALES TRANSACTION For presentation of the offered FareContract | ||||
element | customerPurchasePackages | 0: * | CUSTOMER PURCHASE PACKAGEs bought by SALES TRANSACTION |
TravelSpecification
TravelSpecification < FareContractEntry < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | Name | 1: 1 | Name of TRAVEL SPECIFICATION | |
element | Description | 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 | 1: * | SPECIFIC PARAMETER ASSIGNMENTs relating to TRAVEL SPECIFICATION |
SpecificParameterAssignment
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:
|
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:
|
element | limitations | 1: * | Limitations (i.e. limitation of use) for the assignment | |
element | ValidityParameterAssignmentType | RelativeOperatorEnumeration | 0: 1 | Comparison operator for matching validity parameter values Allowed values:
|
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:
|
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:
|
element | temporalValidityParameters | 0: * | Temporal validity parameters for the assignment
| |
element | validityParameters | 0: * | Validity parameters for the assignment | |
element | TimeIntervalRef | 0: 1 | References to TIME INTERVALS pertaining to FARE STRUCTURE ELEMENT | |
element | GeographicalIntervalRef | 0: 1 | References to GEOGRAPHICAL INTERVALS pertaining to FARE STRUCTURE ELEMENT | |
element | 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:
|
element | includes | 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) |
TravelDocument
TravelDocument < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | Name | 0: 1 | Name of TRAVEL DOCUMENT | |
element | Description | 0: 1 | Description of TRAVEL DOCUMENT | |
element | PrivateCode | xsd:normalizedString | 0: 1 | External identifier of TRAVEL DOCUMENT |
element | TypeOfTravelDocumentRef | 0: 1 | Reference to a TYPE OF TRAVEL DOCUMENT | |
element | CustomerPurchasePackageRef | 0: 1 | Reference to a CUSTOMER PURCHASE PACKAGE | |
element | MarkedAs | MarkedAsEnumeration | 0: 1 | Usage/marking status of TRAVEL DOCUMENT Allowed values:
|
CustomerPurchasePackage
CustomerPurchasePackage < PriceableObject < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | SalesOfferPackageRef | 1: 1 | Reference to a SALES OFFER PACKAGE for which this is a purchase | |
(choice) | CustomerRef | 0: 1 | Reference to the CUSTOMER associated with CUSTOMER PURCHASE PACKAGE | |
CustomerAccountRef | Reference to the CUSTOMER ACCOUNT associated with CUSTOMER PURCHASE PACKAGE | |||
element | CustomerPurchasePackageStatus | CustomerPurchasePackageStatusEnumeration | 0: 1 | Status of CUSTOMER PURCHASE PACKAGE Allowed values:
|
element | travelSpecifications | 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 | 0: * | List of CONSUMPTION UTILISATION DEPENDENCIES in CUSTOMER PURCHASE PACKAGE | |
element | customerPurchasePackageElements | 1: * | CUSTOMER PURCHASE PACKAGE ELEMENTs associated with the CUSTOMER PURCHASE PACKAGE | |
(choice) | prices | 0: * | CUSTOMER PURCHASE PACKAGE PRICEs associated with the CUSTOMER PURCHASE PACKAGE | |
Reference to a CUSTOMER PURCHASE PACKAGE PRICEs associated with the CUSTOMER PURCHASE PACKAGE |
CustomerPurchasePackageElement
CustomerPurchasePackageElement < PriceableObject < DataManagedObject < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
element | SalesOfferPackageElementRef | 1: 1 | Reference to a SALES OFFER PACKAGE for which this is a purchase | |
element | elementAccesses | 1: * | CUSTOMER PURCHASE PACKAGE ELEMENT ACCESSes making up the CUSTOMER PURCHASE PACKAGE ELEMENT | |
element | validityParameterAssignments | 1: * | ACCESS RIGHT PARAMETER ASSIGNMENTs selected for the CUSTOMER PURCHASE PACKAGE ELEMENT | |
element | prices | 1: * | CUSTOMER PURCHASE PACKAGE ELEMENT PRICEs associated with the CUSTOMER PURCHASE PACKAGE ELEMENT |
CustomerPurchasePackageElementAccess
CustomerPurchasePackageElementAccess < VersionedChild < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
(choice) element | ValidableElementRef | 1: 1 | VALIDABLE ELEMENT associated with the CUSTOMER PURCHASE PACKAGE ELEMENT ACCESS | |
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:
|
element | validityParameterAssignments | 0: * | CUSTOMER PURCHASE PARAMETER ASSIGNMENTs selected for the CUSTOMER PURCHASE PACKAGE ELEMENT ACCESS |
CustomerPurchaseParameterAssignment
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:
|
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:
|
element | limitations | 1: * | Limitations (i.e. limitation of use) for the assignment | |
element | ValidityParameterAssignmentType | RelativeOperatorEnumeration | 0: 1 | Comparison operator for matching validity parameter values Allowed values:
|
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:
|
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:
|
element | temporalValidityParameters | 0: * | Temporal validity parameters for the assignment
| |
element | validityParameters | 0: * | Validity parameters for the assignment | |
element | TimeIntervalRef | 0: 1 | References to TIME INTERVALS pertaining to FARE STRUCTURE ELEMENT | |
element | GeographicalIntervalRef | 0: 1 | References to GEOGRAPHICAL INTERVALS pertaining to FARE STRUCTURE ELEMENT | |
element | 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:
|
(choice) element | includes | 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) | |
Prices
CustomerPurchasePackagePrice
CustomerPurchasePackagePrice < FarePrice < VersionedChild < EntityInVersion < Entity | ||||
---|---|---|---|---|
XML-type | Name | Datatype | Cardinality | Description |
CustomerPurchasePackagePrice inherits from FarePrice without introducing new elements or attributes. |