Quick access to API-related documents
GUI
Reference train creation
Basic steps to create a reference train.
- New tailor-made reference train creation – Video
- New reference train creation form PaP search
Editing reference train
How to add PaP to an existing reference train
How to edit the reference train
How to manage my territory
How to manage my locations
How to edit the train parameters
How to copy train parameters
How to add border sections
How to manage train parameters
How to use the search functionality
Working with offers
How to create an offer
Working with PaPs
Working with PaPs as an IM
Other views
How to use the search
Compare function
How to manage reference train filters
How manage filters
How to create PaP filers (PaP search)
API
PCS Capacity Broker API
1.0 Introduction
An important aspect of PCS is its connection via automatic programming interface (API) to national (IM and RU) systems. Via API communication, it is possible to trigger actions and be notified when an action is triggered in PCS without the use of PCS’s graphical user interface. API communication occurs through a standardised set of TAF TAP TSI messages.
2.0 TAF TAP TSI
The technical specifications for interoperability relating to telematic applications for freight or passenger services (TAF TAP TSI) provide common standards for the exchange of data related to railway capacity and traffic management activities. This allows for direct communication between communication partners, as well as communication between central European IT tools (for example PCS CB).
A common XSD schema is used to define data standards and messages used for API communication. PCS CB uses the schema version 3.4.1.0. The complete schema and messages can be found at this link. Additional information regarding TAF TAP TSI and XSD schemas can be found at the Joint Sector Group website.
3.0 Common Interface Architecture
The common interface facilitates the exchange of inbound (from interfacing companies to PCS) and outbound (from PCS to interfacing companies) TAF TAP TSI messages. The CI architecture is detailed in the following visual:
4.0 PCS CB API testing
PCS CB is currently under development and will replace the current PCS (PCS Envelope Concept). An important aspect of this development is comprehensive testing by users prior to its adoption for use in production: this testing is performed by dedicated working group.
In addition to the work conducted by this dedicated group, a test environment and materials (specifications and other general information) is publicly available. Support from the RNE PCS team to public testers is limited, however the reporting of issues and comments is welcome (please send issues and comments to dev.pcscb@rne.eu).
4.1 PCS Environments and Local Instances:
There is one PCS environment which is available to testers: PCS Pre Production Sandbox (https://cb-pre-prod-sandbox.rne.eu/pcs-cb/). This environment utilises the RNE Pre production LI (local Instance), the information for which is provided below:
More detailed information regarding PCS environments and local instances can be found in here.
4.2 Connecting and testing
Users wishing to test PCS CB’s API functionalities can do so either via direct CI connection between their national system and PCS, or via SoapUI.
4.2.1 LI connection
- If the IM or RU IT system of the user’s company has a common interface, their tool can be connected to PCS via the CI. The table in section 4.2.3 indicates which companies are currently connected (see configuration type ‘Company CI’)
- Companies wishing to connect can send an email to dev.pcscb@rne.eu with the following details of their CI:
- IP address
- DNS/hostname
- Port number
- Instance number
4.2.2 SoapUI
- SoapUI is a free software which is used to send XML messages, further information can be found at this link: https://www.soapui.org/
- SoapUI allows a user to simulate messages from their company in case a CI connection is not yet possible
- Templates for all messages which are sent from IMs and RUs are available (see section 4.4). These templates can be imported directly into SoapUI.
- In order to send messages from a company via SoapUI, a ‘local connection’ must first be configured in the PCS LI. Users wishing to do API testing via SoapUI should send their companies’ name and UIC RICs code to dev.pcscb@rne.eu
- The table in the section 4.2.3 indicates which companies already have this local connection (see Configuration Type ‘Local RNE CI’)
4.2.3 Configured companies
| Configuration type | Company name | Company code | Company type |
| Local RNE CI | SNCF Reseau | 0087 | IM |
| Local RNE CI | RFI | 0083 | IM |
| Local RNE CI | SBB Infrastructure | 0085 | IM |
| Company CI | DB InfraGO | 0080 | IM |
| Local RNE CI | ACF | 2189 | IM |
| Company CI | INFRABEL | 0088 | IM |
| Company CI | ProRail | 0084 | IM |
| Local RNE CI | Banedanmark | 0086 | IM |
| Company CI | Trafikverket | 0074 | IM |
| Company CI | Bane NOR Bane NOR | 0076 | IM |
| Local RNE CI | Infraestruturas de Portugal | 0094 | IM |
| Local RNE CI | ADIF | 0071 | IM |
| Local RNE CI | ÖBB-Infrastruktur AG | 0081 | IM |
| Local RNE CI | VPE | 3032 | IM |
| Local RNE CI | ZSR-I, Železnice Slovenskej republiky | 0056 | IM |
| Company CI | Správa železnic, statni organizace | 0054 | IM |
| Local RNE CI | TRENITALIA FRANCE | 3216 | Applicant – Passenger |
| Local RNE CI | SBB Personenverkehr | 1285 | Applicant – Passenger |
| Local RNE CI | NS International | 1184 | Applicant – Passenger |
| Local RNE CI | Société nationale des chemins de fer Belges | 1088 | Applicant – Passenger |
| Local RNE CI | SJ AB | 1174 | Applicant – Passenger |
| Local RNE CI | Øresundståg | 3126 | Applicant – Passenger |
| Local RNE CI | Green Cargo | 2174 | Applicant – Freight |
| Local RNE CI | Hector Rail AB | 3208 | Applicant – Freight |
| Company CI | ČD Cargo, a.s. | 2154 | Applicant – Freight |
| Local RNE CI | DB Cargo Deutschland AG | 2180 | Applicant – Freight |
| Local RNE CI | SIBELIT | 8987 | Applicant – Freight |
| Local RNE CI | LOKORAIL | 3080 | Applicant – Freight |
| Local RNE CI | Vy Tag | 2174 | Applicant – Freight |
| Local RNE CI | DB Fernverkehr AG | 2480 | Applicant – Passenger |
| Local RNE CI | PKP Intercity | 1251 | Applicant – Passenger |
| Local RNE CI | Thalys International | 3018 | Applicant – Passenger |
| Local RNE CI | Lineas | 2188 | Applicant – Freight |
| Local RNE CI | TX Logistik AG | 3308 | Applicant – Freight |
| Local RNE CI | Crossrail Benelux | 3423 | Applicant – Freight |
| Local RNE CI | THI Factory S.A. | 0018 | Applicant – Passenger |
| Local RNE CI | NS Reizigers BV | 1484 | Applicant – Passenger |
| Local RNE CI | Arriva Nederland | 3095 | Applicant – Passenger |
| Local RNE CI | Vygruppen AS | 1076 | Applicant – Passenger |
| Local RNE CI | DB Regio AG | 3864 | Applicant – Passenger |
| Local RNE CI | Rail Cargo Austria | 2181 | Applicant – Freight |
| Local RNE CI | PKP CARGO INTERNATIONAL a.s. | 3145 | Applicant – Freight |
| Local RNE CI | METRANS Rail s.r.o. | 3207 | Applicant – Freight |
| Local RNE CI | CD ceske drahy | 1154 | Applicant – Passenger, freight |
| Local RNE CI | Arriva vlaky | 3189 | Applicant – Passenger |
| Local RNE CI | ÖBB Personenverkehr AG-FV | 1181 | Applicant – Passenger |
| Local RNE CI | Europe Express | 5223 | Applicant – Passenger |
| Local RNE CI | Transdev Sverige AB | 5006 | Applicant – Passenger |
| Local RNE CI | CargoNet | 4314 | Applicant – Passenger |
4.2.3 PCS Pre Production Local Interface
Users testing via SoapUI and direct CI connection can see inbound and outbound message flows in the PCS Pre production LI application. To have an account created in the LI, testers should send an email to dev.pcscb@rne.eu with the following information:
- First and last name
- Company
- Work email address
The Pre Production LI can be accessed via this link: https://ci-cb-pre-prod.rne.eu:8443/LI/logoutUser.action
4.3 Testing PCS API
Testing of PCS CB’s API functionalities should be structured around the PCS Technical Specifications and the testing framework (see section 4.4)
The testing framework should be followed based on the process flows included in the technical specifications (section 4 – Process flow). Each scenario corresponds to a specific action in the corresponding process type. The scenarios shall be tested according to the sequence described in the process flow.
Example:
The promotion of a Reference Train from Harmonisation to Path Elaboration corresponds to scenario ID 65 and is named either “PR submission (no PaPs included in the Reference Train)” or “PR submission (PaPs included in the Reference Train)”.
The following available scenario to continue the process are scenario ID 95, 324 or 127.
In case a scenario is not successful, a message can be sent to dev.pcscb@rne.eu with the details of the failed test.
4.4 PCS API Documentation
The link to the PCS Technical Specifications is currently only accessable via Microsoft Edge or Firefox. If accessing through these browsers is not possible, please contact dev.pcscb@rne.eu.
