Rolling-Stock API (beta)
Rolling stock is a database that contains rolling material. This may be a train carriage or a bus. It may also be a airplane or a ferry, so "rolling" is somewhat misleading.
Authentication
You need a valid token to use this service. In order to issue a valid token you must have a client_id and client_secret(the mechanisms for obtaining these are not in place yet).
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.
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.
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 each other 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 application.
Logical Seat Properties
Logical seat properties determines properties of a seat for a given application.
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 logical seat 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.