sales
- Kristian Syversen (Unlicensed)
- Arne Seime (Unlicensed)
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 |
|---|