FareXChange Profile - Examples

UK Common XML Resources

All the examples reference a common set of fixed values that can be used to classify and validate UK network and fare data. The common  elements are contained in a separate COMPOSITE FRAME supplied as part of the FareXChange  profile specification.

Implementations should embed and reference these values so as to be able to use automatic validation tools to check that only the indicated code values are used.

Contents :

  1. Features.
  2. XML example.

FEATURES:

The Common frames include:

> Common fare components :

Common definitions for tariffs and fare products:

  • User Profile Types
    • Adult.
    • Child.
    • Infant.
    • Student.
    • Senior.
    • Young_person.
    • Armed_forces.
    • Registered_disabled.
  • Distribution channels.
    • at_stop.
    • at_counter.
    • self_service_ticket_machine.
    • on_board.
    • online.
    • online_subscription.
    • operator_travel_shop.
    • travel_agent.
    • call_centre.
    • employee_organisaton.
    • statutory_organisaton.
  • Fulfilment methods.
    • collect_on_board.
    • collect_from_machine.
    • collect_at_counter.
    • collect_from_agent.
    • mobile_app.
    • self_print.
    • online_propagation.
    • email.
    • post.
    • courier.

> Common resources :

Common organisation and responsibility definitions.

  • CODE SPACES for reserved UK data sets:NaPTAN
    • naptanStop:NaPTAN stops (SCHEDULED STOP POINTs)
    • nptgLocality: NPTG localities (TOPOGRAPHIC PLACES)
    • noc: National Operator codes
    • fxc: FareXChange metadata and values
  • VERSIONS of theFareXChange profile
  • DATA SOURCEs originating national data
  • National Organisations
    • Department of Transport.
    • Traveline.
    • National rail.
  • Responsibility Sets for National data

> Common code values ::

Common code values for use in validation.
  • Types of Stop (UK classifications)
  • Types of Fare Zone
    • fare_zone@operator
    • fare_zone@multi_operator
    • fare_zone@concessionary
  • Classes of Use
    • first
    • second
  • Types Of Tariff
    • Distance_kilometers
    • flat
    • point_to_point
    • zone_to_zone
    • zonal
    • section
    • banded
    • stored_value
    • multitrip
    • identity_card">
  • Types of Fare Product
    • Trip
      • standard_product@trip@short_hop
      • standard_product@trip@single
      • era:standard_product@trip@time_limited
      • special_product@trip@period_return
      • era:special_produc@trip@day_return
    • Pass
      • standard_product@pass@day
      • standard_product@pass@24H
      • standard_product@pass@period
    • Carnet
      • standard_product@carnet@trips
      • standard_product@carnet@days
    • Discount
      • standard_product@discount@sales
      • standard_product@discount@usage
    • Stored value
      • standard_product@stored_value@epurse
  • Charging Moments
    • prepayment
    • prepayment@pay_as_you_go
    • prepayment@bundled
    • prepayment@free
    • post_payment
  • Types of Travel Document.
    • distribution_channel_dependent
    • printed_ticket
    • hand_written_ticket
    • magstripe_printed_ticket
    • self_print_ticket
    • pass
    • mobile_app_ticket
    • smart_card
    • electronic_document
    • membership_card
  • Types of Access Right Assignment
    • eligible
    • can_access
    • cannot_access
    • must_access
    • can_access_when
    • can_access_if_purchased
    • can_use_with_type_of_travel_document
    • condition_of_use
    • condition_of_sale
    • can_purchase
    • can_purchase_when
    • can_purchase_where
    • gives_entitlement
    • prerequisites
    • penalties
    • can_use_to_pay_for
    • payment_schedule
    • reservation_condition
    • distribution_channel_restriction
    • takes_properties_from_group
    • quota_applies
    • validity_chaining
  • Types Of Sales Offer Package
    • standard_product@all_operators
    • standard_product@multi_operator
    • standard_product@operator
    • special_product@operator
  • Types of Frame
    • UK_general_profile@locations
    • UK_Bus_tariff_profile@fare_network
    • UK_Bus_tariff_profile@service_network
    • UK_Bus_tariff_profile@service_network@line
    • UK_Bus_tariff_profile@site_network
    • UK_Bus_tariff_profile@products
    • UK_Bus_tariff_profile@products@by_line
    • UK_Bus_tariff_profile@prices
    • UK_Bus_tariff_profile@calendar
    • UK_Bus_tariff_profile@operator_resources
    • UK_Bus_tariff_profile@operator_fare_resources
    • UK_Bus_tariff_profile@transactions
    • UK_Bus_tariff_profile@transactions_composite
    • UK_Bus_tariff_profile@composite
    • UK_Bus_tariff_profile@UK_common_resources
    • UK_Bus_tariff_profile@UK_common_resources_composite
    •

User Profiles

USER PROFILE

Personal

Discounted

Note /p>

Adult

x

x

Over 16

Infant

x

yes

Babes in arms free

Child

x

yes

c5 – c16 years

Youth

x

yes

years

School Pupil

x

yes

At School

Student / Trainee

yes

yes

Apprentice

Senior

yes

yes

>60 years

Disabled

yes

yes

Registered disabled

Disabled Companion

yes

yes

With disabled

Job seeker

yes

yes

Go to Top

XML example:

xmlXML document for UK Common resources

common COMMON COMPONENTS for FareXChange

Declared in a separate separate "Uk Common Component" FARE FRAME and RESOURCE FRAMEs.

  • A FARE FRAME containing the common operator definitions for UK Fares including:
    • CURRENCY UNITs
        • FARE PRODUCT
      • GBP
      • EURO
    • USER PROFILES - common user types
    • DISTRIBUTION CHANNELs
    • FULFILMENT METHODS
    • TYPES OF TRAVEL DOCUMENT.

common COMMON Resources for for FareXChange

Declared in a separate "FareXChange UK Common Resource" COMPOSITE FRAME. 

  • A RESOURCE FRAME containing the common definitions for the UK Fare profile including:
    • CODE SPACEs
    • VERSIONS
    • OPERATORs - Dft, with contact details . Identified by NOC code
    • DATA SOURCEs - originating data
    • RESPONSIBILITY SET indicating ORGANISATIONs responsible for managing data.
    • VALUE SETS - groups of allowed values
      • TYPES OF STOP (UK CLASSIFICATIONS)
      • TYPES OF FARE ZONE.
      • CLASSES OF USE.
      • TYPES OF TARIFF.
      • TYPES OF FARE PRODUCT.
      • CHARGING MOMENTS.
      • TYPES OF TRAVEL DOCUMENT.
      • TYPES OF ACCESS RIGHT ASSIGNMENTs.
      • TYPES OF SALES OFFER PACKAGE.
      • TYPES OF FRAME.

    Go to Top

Go to Top

 
logo

© Crown Copyright  2018-20
Page last updated: 2020/09/15