BPLAN Geography: Difference between revisions

From Open Rail Data Wiki
Added BPlan API
m Update to identify current data sources
 
(8 intermediate revisions by 3 users not shown)
Line 40: Line 40:
|-
|-
| REF > SER
| REF > SER
| Service Codes (not released in the Open Data extract)
| Service Codes
|-
|-
| REF > SLE
| REF > SLE
Line 84: Line 84:
More detailed documentation on the [[BPLAN data structure|data structure]] is available.
More detailed documentation on the [[BPLAN data structure|data structure]] is available.


= Availability =
= Downloading =


The data is available for each principal and subsidiary timetable (twice a year).
Up-to-date data is available on the [https://raildata.org.uk/dashboard/dataProduct/P-03715cb3-22f2-48b6-94f6-bd88da9335f3/overview Rail Data Marketplace].  Links to historical data are contained on a [[BPLAN_Geography_Data|separate page]].
 
The data was once also previously available via the [[Network_Rail_API_Platform|Network Rail API platform]], but this is closed to new registrations and offers no advantage ove the source on the Rail Data Marketplace.


= Limitations =
= Limitations =


* Service Code reference data (SER) is not currently published, as it contains data about freight operators
* Service Code reference data (SER) is not available in the historical files, but is available in the current data from the Rail Data Marketplace
* Bid and offer files (sometimes called PEX files) between Network Rail and train operators are not published, as they may contain unworkable train bids or sensitive data
* Bid and offer files (sometimes called PEX files) between Network Rail and train operators are not published, as they may contain unworkable train bids or sensitive data
= Downloading =
Links to current and historical data are contained on a [[BPLAN_Geography_Data|separate page]].


[[Category:BPLAN Data]]
[[Category:BPLAN Data]]
= API =
An API is now available that retrieves a gzip file containing the current and next timetable BPlan files.
An account is required in order to access the API which can be requested by contacting opendata@networkrail.co.uk. Once an account has be authorised, you will receive a client_id and client_secret. Below is the API url and an example of how to use the credentials within Postman.
'''API URL:''' https://data.networkrail.co.uk/api/pifgeography/v1/train/referenceDataFile
[[File:BPlanHeaderSettings.png|thumb|BPlan Header Settings]]
https://www.networkrail.co.uk/who-we-are/transparency-and-ethics/transparency/open-data-feeds/

Latest revision as of 14:13, 30 May 2024

The rail industry uses a system called BPLAN (a successor to a system called APLAN) to manage a master set of geography data used when planning trains. Network Rail create extracts of this geographical data as a PIF.

Data

The following sets of data are included in the extracts:

Record type Description
PIF Header record
REF > ACC Accommodation Class codes
REF > ACT Activity codes
REF > BHX Bank Holiday Excepted codes
REF > BRA Brand codes
REF > BUS Business Sector codes (no longer used)
REF > CAT Catering codes
REF > OPC Operating Characteristics
REF > PWR Power Supply Type codes
REF > RES Reservations codes
REF > SER Service Codes
REF > SLE Sleeper codes
REF > TCL Train Class codes
REF > TCT Train Category codes
REF > TOC Train Operating Company codes (not ATOC codes)
REF > TRS Train Status codes used in bid/offer files (not released as Open Data)
REF > TST Publication Status codes
REF > ZNE Data Areas
TLD Timing loads
LOC Location codes
PLT Platform data
NWK Network links
TLK Timing links
PIT Trailer record

More detailed documentation on the data structure is available.

Downloading

Up-to-date data is available on the Rail Data Marketplace. Links to historical data are contained on a separate page.

The data was once also previously available via the Network Rail API platform, but this is closed to new registrations and offers no advantage ove the source on the Rail Data Marketplace.

Limitations

  • Service Code reference data (SER) is not available in the historical files, but is available in the current data from the Rail Data Marketplace
  • Bid and offer files (sometimes called PEX files) between Network Rail and train operators are not published, as they may contain unworkable train bids or sensitive data