/
sales

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

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

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

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

Customer Account log entries

CustomerAccountEntry

CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

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

XML-type

Name

Datatype

Cardinality

Description

CustomerRegistration inherits from CustomerAccountEntry without introducing new elements or attributes.

CustomerDeregistration

CustomerDeregistration < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity

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

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

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

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

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

TokenTravelDocumentRegistrationEntry < CustomerAccountEntry < DataManagedObject < EntityInVersion < Entity