OSDM Version 3.2

We are happy to release the OSDM Version 3.2.

Here are the release notes.

More to come!

Thanks to all the Team for its hard work.

What's Changed

• Create OSDM-online-webhook-v3.2.0.yml as initial version by @CGantert345 in #363
• Online API specification for Bileto Sandbox server by @jspetrak in #364
• Partial refund by @CGantert345 in #380
• multiple last names by @CGantert345 in #376
• split reservation added by @CGantert345 in #381
• Change value to "value" by @CGantert345 in #385
• "" type changed by @CGantert345 in #388
• #369 AbstractBookingPart.confirmableUntil can have null value by @jspetrak in #392
• Versioning and file respones for GET /places by @ralfbayer-db in #413
• 393 third party accounting reference by @CGantert345 in #394
• Fix AccountingRef by @ralfbayer-db in #418
• reimboursementMethod by @CGantert345 in #421
• consumptions added in travel pass account by @CGantert345 in #423
• WIP: I-72.1 FulfillmentParts for Offer #320 by @jspetrak in #321
• Adding PDF by @schlpbch in #425
• Improve documentation of TripCoverage by @ralfbayer-db in #429
• Improve documentation of LegAttribute by @ralfbayer-db in #430
• 412 mapping back from bookingparts to offerparts by @ralfbayer-db in #428
• fulfillment status moved by @CGantert345 in #422
• Fix typos and improve summaries by @schlpbch in #440
• compartment number added,direction of signs added by @CGantert345 in #444
• passenger refs missing in fare by @CGantert345 in #433
• AccommodationType and AccommodationSubType items in openapi by @jspetrak in #389
• dscription added for description of applied passenger type by @CGantert345 in #424
• appliedReductions added by @CGantert345 in #453
• returnTripSpecification added by @CGantert345 in #451
• draft for multiple seat maps by @CGantert345 in #386
• product tags added by @CGantert345 in #452
• Booking Split function by @Nokkan in #338
• Reduce minimum value for stop indexes to 0. by @ralfbayer-db in #457
• 408 need single soldproductid on offer parts by @ralfbayer-db in #458
• Amended description of street and house number by @ralfbayer-db in #460
• 412 mapping back from bookingparts to offerparts 2 by @ralfbayer-db in #459
• Release of OSDM 3.2 by @jspetrak in #463
• #454 Trips missing in ExchangeOperation by @jspetrak in #464
• Allow for transport mode to be filtered by section (defined by vias) by @ralfbayer-db in #468
• Add a new endpoint for booking cleanup by @ralfbayer-db in #467
• AcailabilityScope should contain an array of references to allow for multiple offers in one view by @CGantert345 in #472
• upload IRS documents by @schlpbch in #473
• fix typos by @schlpbch in #475

Full Changelog: V3.1.0...v3.2

OSDM Version 3.0.3 Maintenance Release and OSDM Version 3.1

We are happy to release Version 3.0.3 of the OSDM Specification and the OSDM Version 3.1. This is a maintenance release which also adds some features requested by the Swedish market in non-breaking way adhering to semantic versioning in 3.03.

See the Change Log for more details.

More to come!

Thanks to all the Team for its hard work.

OSDM Version 3.0.2 Maintenance Release

We are happy to release Version 3.0.2 of the OSDM Specification. This is a maintenance release which also adds some features requested by the Swedish market in non-breaking way adhering to semantic versioning.

See the Change Log for more details.

More to come!

Thanks to all the Team for its hard work.

v3.0.0

We are proud to release Version 3.0 of the OSDM Specification. In scope of this increment are various improvements proposed by the different parties (Retailers, Distributors, Railways, Bus Undertakings). Focus is to support the Swedish Market which revamps its distribution and pricing landscape based on OSDM.

See the Release Notes 3.0 for more details.

Additionally, the OSDM sandbox by Sqills has been revised and is now based on their productive system.

For the first time we are also releasing the OSDM UML model from which the YAML specification is being generated.

Furthermore we have started work on a joint test and validation set. This should help the adoption of OSDM as well as guarantee that the implementations are interoperable.

More to come!

Thanks to all the Team for its hard work.

v2.0.0

We’re proud to release Version 2.0 of the OSDM Specification.

In scope of this increment were various improvements proposed by railways as well as distributors. The following features have been added with version 2.0 of OSDM.

• Terminology aligned with TAP-TSI
• Unified resource for trip based offers and non-trip based offers
• Separate resource to retrieve availabilities for seats, couchettes,…
• Change of seat, couchette,.. in the booked offer
• Option to extend the booking time limit (OnHold)
• Option to release tickets as an intermediate step for a refund
• Option to cancel a fulfillment
• Reimbursement of unused tickets
• Booking Search

This is an important release as it is the basis of implementations in the Swedish as well as the Swiss market. Furthermore, part of the documentation will be adopted by the TAP-TSI regulation.

See the Release Notes 2.0 for more details.

More to come!

Thanks to all the Team for its hard work.

OSDM v.1.4.0 Release

What's New in OSDM Version 1.4

The following features have been added with version 1.4 of OSDM.

Booking Synchronization

If there is change in a trip or a booking, we have added an API that a carrier/allocator system can inform a distributor about that fact, that a trip or a booking has changed. The distributor can then itself inform a passenger or the purchaser e.g. a travel agency about changes to its booking.

The API consists of a set of webhooks that allow to send events about changes which involve e.g. trip cancelled, booking cancelled or seat changed. See Booking Synchronization for details.

Added A Getting Started Tutorial

The OSDM API is feature rich. The reason for its richness is that OSDM aims to cover all possible public transportation products and distribution processes within Europe and beyond.

Nevertheless the complete booking flow consist of three simple REST calls only, same for refund. To help you getting started we have added a Getting Started Tutorial that gets you up to speed in no time.

Added Support for Paperless Complaint Management

For a customer it must be possible to submit a claim for a booking or parts of it (e.g. in case of a return trip) where the service has not been provided as promised. This includes delays of trains as well as service derogation (e.g. first class not available, ...).

OSDM now provides an online API to submit a complaint for a booking which can be implemented by any distributor to digitize this process. See the /complaints resources for details.

Differentiate Between Passenger and Purchaser

Especially for travel agencies or the B2B business center it's important to distinguish between purchaser and passenger. I.e., a purchaser is not always a passenger. Thus, we have added the purchaser the API.

Add Constraints on Allowed Journey Interruptions

If an open ticket has constraints on how often a journey can be interrupted this fact can now be expressed in the Offline as well as Online Fare data.

Add Constraints on Multi-Journey Products

With this version, multi-journey products can be expressed.

Improved OJP Support

The LegBoard, LegIntermediates and LegBoard entities have been added according to the Open Journey Planning (OJP) specification.

Reduction Cards are Available to Ticket Vendors

Reduction cards are now available to ticket vendors to be used for selecting the cards for requests and in customer profiles. See /masterdata/reductionCards for details.

Add the Responsible TCOs in the Booking Data

New we can support cases where the ticket control organization (TCO) to control tickets is different from the fare provider.

Option to Indicate CarrierConstraints at the Level of RegionalValidity and ViaStation

This feature on the OSDM offline part of the specification allow to indicate CarrierConstraints at the level of RegionalValidity and ViaStation in the fare.

Travel Validity Depending on Boarding Time Only

Some special tickets define a travel validity based on the boarding time only. These tickets are the valid on that train until the passenger leaves the train.

E.g. Eurail tickets on specific night trains where the Eurail ticket must be valid at boarding time only and the passenger can stay on the train until his destination on the next day.

Other work addressed includes:

• Improving the API's description
• Fixing minor inconsistencies
• Incorporating feedback from the first implementors

OSDM v.1.3.0 Release

What's New In OSDM Version 1.3

The following features have been added with version 1.3 of OSDM.

Align to /places and /trips to Open Joruney Planer (OJP) of Transmodel

The main focus of this PI was to align the modelling of places and trips of OSDM to the model of OJP. The benefits of this change are to profit from the domain knowledge of trip planning as well as to comply with European initiative such as the National Access Point initiative. Additionally, OJP allows to search trips for new modes of transport such as scooters or bikes using the concept of continuous leg.

See the /places and the /trips resource for details.

Add real time support

Another advantage of the alignment with OJP was to get real time support as part of the OSDM standard. Thus in a trip it is now possible to indicate the actual quay a train is arriving as well as the delay time of a train.

Add support for promotions

The OSDM APIs now allows to pass in promo codes in the offer search criteria. If valid and applicable, they will be taken into account while calculating offers.

See the PromotionCode attribute for details.

Add the possibility for direct booking

If an offer is flag as reusable it can be reused, thus they can be cached on clients side. Thus it isn't necessary to get an offer each and every-time.

This feature allows to implement an expert mode where the cached offers can directly be booked.

Special tariffs can be sent in via the promocode attribute.

Indicate test data in offline data exchange

OSDM offline feature: This feature allows to indicate whether data in the OSDM offline delivery is for testing purposes only.

Other work addressed includes:

• Improving the API's description
• Fixing minor inconsistencies
• Incorporating feedback from the first implementors
• Setting up a mock infrastructure as well as writing actual mocks
• Best Practices concerning non-functional requirements

OSDM v.1.2.0 Release

What's New In OSDM Version 1.2

The following features have been added with version 1.2 of OSDM.

• Add support to sell non-journey based products (passes)

  A new booking flow enables to sell tickets that are not bound to a trip, e.g., day passes or
  ancillary service such a WIFI access. This feature opens the possibility to potentially sell
  public transportation unrelated services such as entrance to a museum or concert.

  See the /non-trip-based-offers for more details.

• Add support to query availabilities

  If supported by the underlying systems, the attribute numericAvailability returns the number
  of offers of a given fare still available. Having the number of available service is of
  special values for agents helping a passenger to find the best time to travel

  Note that the availability is on fares and not on actual seats.

• Complete support for partial refund/exchange

  Exchange of tickets especially with yielded fares is a difficult topic. In this
  release we have carefully reviewed the initial implementation of OSDM V1.1 and completed it
  where necessary. The most atomic element we can after-sale on is a ticket (Ticket Control Number).
  See the resources under Exchange.

• Combination of offers

  While there are powerful combination rules on fare level, OSDM was lacking this feature
  on offer level. With this release, we have added a light-weight option to steer the
  combination of offers. This allows a fare provider or allocator to control the combination
  of its offers with other. This can be used for return tickets as well as offer-based
  through fares.

  In a nutshell the mechanism is the following: if no combination tags are set, an offer
  can be combined with any other offer. However, if the tags are set, only offers which
  contain the tags can be combined. The tags can be defined mutually between two parties.
  See the tripTags and returnTags attribute on Offer.

• Add full support for PRMs

  If a passenger has reduced mobility the basic idea is that an OSDM allocator implementation
  informs the UIC's PRM ABT about the travel wish such that he or she can be contacted by the
  experts. The impacts on OSDM are:

  • If we have a PRM travelling from to A to B (via C) a system implementing OSDM
    must inform the UIC's PRM ABT tool about the assistance needs a these stops.

    Impact on specification: The PRMNeedType NEED_PRM_SUPPORT allows to indicate the need to
    ask for support at a station. In this case the allocator needs to inform the UIC ABT Tool
    to contact the passenger. The allocator thus needs to transfer the passenger's contact
    address (mail or phone) and the booking id.

  • If a request of PRM assistance can not be met, a refund/exchange process must be triggered
    by UIC's PRM ABT tool via the OSDM protocol and the PRM must be informed accordingly.

    Impact on specification: The over rule code PRM_SUPPORT_UNAVAILABLE allows a booking to
    be refunded or exchanged by the UIC PRM ABT tool even when the fare is
    non-refundable/exchangeable.

Other work addressed includes:

• Improving the API's description
• Fixing minor inconsistencies
• Incorporating feedback from the first implementors
• Setting up a mock infrastructure as well as writing actual mocks
• Best Practices concerning non-functional requirements

OSDM v.1.1.0 Release

In scope of this increment were various improvements proposed by railways as well as distributors:

• I-1 Enable combination rules between offers (Amadeus/Sqills/SBB)
• I-2 Support for stateless offers/booking processes (Sqills/DB)
• I-5 Add support for a fee (DB)
• I-9 Add binary in fulfillment messages (DB)
• I-23 Handle reduction cards that include other cards (Offline-Only)
• I-24 Add rules for minimum number of passengers (Offline Only)
• I-25 Short station name for route descriptions needed (Offline-Only) (DB, UIC)
• I-31-Remove-SEPERATE_TICKET-as-cluster-type (Offline-Only) (DB)

OSDM v.1.0.0 Release

v1.0.0

OSDM Version 1.0