Guides

This guide will go through important concepts and the overall model of Rolling stock to better understand and make use of this service.

For simplicities sake, trains are used as a reference to easier understand the concepts. Though this example is not limited by trains and can be expanded to the case of a bus as an example.

ER Model

Physical structure

The physical structure describes a carriage visually for a given operator and the eventual modifications they have made. In practice it is usually the same or based on a litra for norwegian trains.

Basic Element

A basic element describes a physical carriage. For example the adaption of litra A7-1 by VY.

A basic element is identified by series and version. The series is assigned by the user. The version is set to 1 when the element is created. The version is bumped when new versions with the same series are created.

Basic Element Properties

Basic element properties describe general properties of the carriage. For example if there is wifi or a wheelchair lift.

Basic Seat

A basic seat is a seat in a basic element. It may also used for other objects like space for a standing person or a bicycle.

Basic Seat Properties

Basic seat properties describe the fundamental properties of a basic seat. This should not be used to determine usage properties.

API

Get basic element by id.

The basic element structure is fetched based on database id.

Get basic elements by search criteria.

A list of basic elements are fetched based on search criteria.

  • series: The series specified when the element was created. Example: GOA-BM73A
  • version: The version assigned when the element was created. Example: 2
  • status: The status of the element: Example: ACTIVE
  • name: The name of the element. Used by substring match. Example: GOA
  • limit: The maximum number of elements fetched. example: 10
  • page: The page number if more than limit elements are fetched. Example: 5
  • sort: Sorting strategy. Zero or more may be specified. Example: NAME_DESCENDING

Create basic element.

A new basic element is created. The new element will have the given series and the next version.

Update basic element.

An element with the specified database id will be updated.

Applied structure

The applied structure refines an occurrence of the physical structure by adding properties that determines its application. This could for example be the operators own version of litra A7-1 as it is being used day trains on the Dovre line.

Logical Element

A logical element describes a basic element as it would be used in a given application. For example be the operators own version of litra A7-1 as it is being used day trains on the Dovre line. The accompanying basic element is identified by database id or the series/version.

A logical element is identified by series and version. The series is assigned by the user. The version is set to 1 when the element is created. The version is bumped when new versions with the same series are created.

Logical Seat Group

A logical seat group describes a logical compartment. This is used to give a more detailed management of automatic seat allocation. It could for example be desirable that some products manage automatic seat allocation that are closer to eachter than other products. The case of premium seats, travelers are grouped into four, but on standard seats it's sufficient enough that the travelers are allocated to the same compartment. Logical seat groups can be nested.

Logical Seat

A logical seat is based on a basic seat with added properties that specify its appication.

Logical Seat Properties

Logical seat properties determines properties of a seat for a given application.

API

Get logical element by id.

The logical element structure is fetched based on database id.

Get logical element by series and version.

The logical element structure is fetched based on series and version.

Get all logical elements by basic element id.

All logical elements based on a specified basic element are fetched. The basic element is specified by database id.

Create logical element.

A new logical element is created, based on a specified basic element. The new element will have the given series and the next version.

Update logical element.

A logical element is updated.

Consolidated logical element

A consolidated logical element contains the seats from a logical element. Each such seats will have a combination of basic element properties, basic seat properties and basic element properties.

Properties that have a single value do not overlap. They will be picked from the corresponding value in one of the property sets.

Properties that have a set of values, will contain the sum of the corresponding values in all the property sets.

  • fareClass. From logical seat properties.
  • groupBooking. From logical seat properties.
  • accommodationFacility. From basic seat properties.
  • seatAttachment. From basic seat properties.
  • seatPosition. From basic seat properties.
  • relativeDirection. From basic seat properties.
  • nuisanceFacilities. Sum of values from basic element properties and logical seat properties.
  • passengerCommsFacilities: From basic element properties.
  • sanitaryFacilities: From basic element properties.
  • mobilityFacilities: From basic element properties
  • baggageType. Sum of values from basic element properties, basic seat properties and logical seat properties.

Get consolidated logical element by id.

Fetch consolidated element structure from the database id of the logical element.

Get consolidated logical element by series and version.

Fetch consolidated element structure from the series and version of the logical element.

API