DTD: Difference between revisions

From Open Rail Data Wiki
← Older edit
m JayPatel moved page Dtd to DTD
m Update HTTP to HTTPS
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Train companies create various types of data associated with the provision of their rail services, including fares,  
Train companies create various types of data associated with the provision of their rail services, including fares, timetable and routeing data. They use this data to provide rail travel information to their customers in a variety of ways, including through approved websites, via mobile phone apps and at their stations through accredited retail systems.
timetable and routeing data. They use this data to provide rail travel information to their customers in a variety of  
ways, including through approved websites, via mobile phone apps and at their stations through accredited retail systems.


RDG is authorised to make this data available under licence to third parties on behalf of the train companies. Fares,  
RDG is authorised to make this data available under licence to third parties on behalf of the train companies. Fares, Routeing guide and Timetable data is of a technical nature, and you will require a good level of computer skills in order to be able to process the data.
Routeing guide and Timetable data is of a technical nature, and you will require a good level of computer skills in  
order to be able to process the data.


Fares data consists of product information relating to permanent fares offered by the train operating companies. The data  
Fares data consists of product information relating to permanent fares offered by the train operating companies. The data will typically include general fares information such as price, validity, class of travel and restriction information.  
will typically include general fares information such as price, validity, class of travel and restriction information.  


Routeing data is created from the information used to specify route validity for certain fares and prescribed customer  
Routeing data is created from the information used to specify route validity for certain fares and prescribed customer journey route options.  
journey route options.  


Timetable data consists of the train service timetable information provided by the train operating companies. The data  
Timetable data consists of the train service timetable information provided by the train operating companies. The data includes general timetable information such as departure and arrival times for all stations at which a train calls on its journey (e.g. origin, intermediate and terminating).
includes general timetable information such as departure and arrival times for all stations at which a train calls on  
its journey (e.g. origin, intermediate and terminating).


= Accessing Fares, Routeing Guide and Timetable data =
= Accessing Fares, Routeing Guide and Timetable data =
To access Fares, Routeing Guide and Timetable data you must have an account on the National Rail Data Portal (NRDP) at
http://opendata.nationalrail.co.uk. By creating an account, you can register for a subscription to the Fares, Routeing
and Timetable feed.


'''Important''' - Please note NRDP accounts expire after extended periods of no use. The unused account expiry period is  
To access Fares, Routeing Guide and Timetable data you must have an account on the National Rail Data Portal (NRDP) at https://opendata.nationalrail.co.uk. By creating an account, you can register for a subscription to the Fares, Routeing and Timetable feed.
currently set to 30 days. If you create an account and do not consume any of the feeds during this time your account  
 
will be deleted. If your account has been deleted, you will receive a notification email, and you will be able to  
'''Important''' - Please note NRDP accounts expire after extended periods of no use. The unused account expiry period is currently set to 30 days. If you create an account and do not consume any of the feeds during this time your account will be deleted. If your account has been deleted, you will receive a notification email, and you will be able to re-register for a new account.
re-register for a new account.
 
 
== Advice on downloading data ==
== Advice on downloading data ==
Best practice is to check no more than daily for new data.
Best practice is to check no more than daily for new data.


To determine which file is the latest version, each files header contains the last updated date / time stamp
To determine which file is the latest version, each files header contains the last updated timestamp (response HTTP header, Last-Modified).  
(response HTTP header, Last-Modified).  


NRDP will publish data as received from RDG, on a weekly basis. The data is updated at varying rates.  
NRDP will publish data as received from RDG, on a weekly basis. The data is updated at varying rates.  
* Fares, Routeing Guide and Timetable data - At selected times of the year, RDG will temporarily suspend Fares data publishing. NRDP will continue to make last retrieved file available to NRDP users.
 
* Routeing data – weekly
* Fares, Routeing Guide and Timetable data - At selected times of the year, RDG will temporarily suspend Fares data publishing. NRDP will continue to make last retrieved file available to NRDP users.
* Timetable data – Files are rarely updated and Users are advised to poll for updates infrequently
* Routeing data – weekly
* Timetable data – Files are rarely updated and Users are advised to poll for updates infrequently


== Examples ==
== Examples ==
After selecting the Fares, Routeing Guide and Timetable data subscription type on NRDP, you can receive the files in 2 steps via a rest client by performing the following steps.
After selecting the Fares, Routeing Guide and Timetable data subscription type on NRDP, you can receive the files in 2 steps via a rest client by performing the following steps.
* Step 1 Authenticate: Perform HTTP POST call to NRDP via https://opendata.nationalrail.co.uk/authenticate to generate a token.
* Step 2 Download file: Perform HTTP GET call to individual NRDP Feed using the token produced in step 1
=== Step 1: Generate Token ===
In this step, using a REST client you perform an HTTP POST call to https://opendata.nationalrail.co.uk/authenticate.
This step requires using your email address and password registered on NRDP and will produce a token key. The following
example shows the HTTP POST request and response with NRDP:
Example HTTP POST Request to NRDP:
    POST https://opendata.nationalrail.co.uk/authenticate HTTP/1.1
    Content-Type: application/x-www-form-urlencoded
    Accept: application/json, text/plain, */*
    Raw payload: username=user1@gmail.com&password=P@55w0rd1
Note: Raw payload values should contain your NRDP credentials
Corresponding example HTTP Response from NRDP:
    {
    "username": " user1@gmail.com ",
    "roles": {
      "ROLE_USER": true,
      "ROLE_DTD": true
    },
    "token": "user1@gmail.com:1491312310772:56c56baa3e56d35ff0ede4a6aad1bcfb"
    }
Each token is valid for 1 hour and you will receive a 401 Unauthorized response when the token has expired.
The following HTTP response example is generated after sending an HTTP request to a NRDP feed with an expired token.
Example HTTP 401 Response Header: Token Expired:
    Date: Thu, 22 Nov 2018 13:39:58 GMT
    Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips
    X-Content-Type-Options: nosniff
    X-XSS-Protection: 1; mode=block
    Cache-Control: no-cache, no-store, max-age=0, must-revalidate
    Pragma: no-cache
    Expires: 0
    X-Frame-Options: DENY
    Content-Type: application/json;charset=UTF-8
    Transfer-Encoding: chunked
Corresponding example JSON Response: Token Expired:


# Authenticate: Perform HTTP POST call to NRDP via https://opendata.nationalrail.co.uk/authenticate to generate a token.
# Download file: Perform HTTP GET call to individual NRDP Feed using the token produced in step 1


    {
=== Step 1: Generate Authentication Token ===
        "timestamp": "2018-11-21T12:34:33.377+0000",
See the [[National Rail Data Portal#Authentication|Authentication]] section on the [[National Rail Data Portal|National Rail Data Portal]] article
        "status": 401,
        "error": "Unauthorized",
        "message": "Unauthorized",
        "path": "/api/staticfeeds/2.0/routeing"
    }
 
 
=== Step 2: Perform a HTTP GET call for each file ===
=== Step 2: Perform a HTTP GET call for each file ===
In this step using a REST client, you would perform a HTTP GET call to each Fares, Routeing Guide and Timetable data  
 
files using the token key produced in step 1. This will produce the zip file containing fixed format flat text file(s)  
In this step using a REST client, you would perform a HTTP GET call to each Fares, Routeing Guide and Timetable data files using the token key produced in step 1. This will produce the zip file containing fixed format flat text file(s) for the corresponding Fares, Routeing Guide and Timetable data feeds.
for the corresponding Fares, Routeing Guide and Timetable data feeds.


The following are the required links to make the respective HTTP GET call:
The following are the required links to make the respective HTTP GET call:
* Fares: https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/fares   
 
* Routeing guide: https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/routeing
* Fares: https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/fares   
* Timetable: https://opendata.nationalrail.co.uk/api/staticfeeds/3.0/timetable
* Routeing guide: https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/routeing
* Timetable: https://opendata.nationalrail.co.uk/api/staticfeeds/3.0/timetable


The following is an example of request/response for Routeing data via NRDP:
The following is an example of request/response for Routeing data via NRDP:
Line 111: Line 51:
Example HTTP GET Request to NRDP feed:
Example HTTP GET Request to NRDP feed:


    GET https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/routeing HTTP/1.1
<pre>GET https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/routeing HTTP/1.1
    Content-Type: application/json
Content-Type: application/json
    Accept: */*
Accept: */*
    X-Auth-Token: user1@gmail.com:1491312310772:56c56baa3e56d35ff0ede4a6aad1bcfb
Host: opendata.nationalrail.co.uk
 
X-Auth-Token: user1@gmail.com:1491312310772:56c56baa3e56d35ff0ede4a6aad1bcfb</pre>


Note: X-Auth-Token header value should contain the token from the authenticate response
Note: X-Auth-Token header value should contain the token from the authenticate response
Line 121: Line 61:
Corresponding example HTTP 200 Response Header:
Corresponding example HTTP 200 Response Header:


    Date: Thu, 22 Nov 2018 13:53:00 GMT
<pre>Date: Thu, 22 Nov 2018 13:53:00 GMT
    Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips
Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips
    Last-Modified: Wed, 21 Nov 2018 05:13:43 GMT
Last-Modified: Wed, 21 Nov 2018 05:13:43 GMT
    Content-Disposition: attachment; filename="RJRG0541.ZIP"
Content-Disposition: attachment; filename="RJRG0541.ZIP"
    Accept-Ranges: bytes
Accept-Ranges: bytes
    X-Content-Type-Options: nosniff
X-Content-Type-Options: nosniff
    X-XSS-Protection: 1; mode=block
X-XSS-Protection: 1; mode=block
    Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
    Pragma: no-cache
Pragma: no-cache
    Expires: 0
Expires: 0
    X-Frame-Options: DENY
X-Frame-Options: DENY
    Content-Type: application/zip
Content-Type: application/zip
    Content-Length: 66021837
Content-Length: 66021837</pre>


Example corresponding fixed format response files:
Example corresponding fixed format response files:
Line 186: Line 126:


Details on how to interpret the fixed format files can be found in specifications listed below.
Details on how to interpret the fixed format files can be found in specifications listed below.
* Fares and associated data feed interface specification (RSPS5045 v.02-00)
 
* National Routeing Guide data feed specification (RSPS5047 v.02-00)
* Fares and associated data feed interface specification ([https://www.rspaccreditation.org/publicDocumentation.php#RSPS5xxx RSPS5045])
* Timetable information data feed interface specification (RSPS5046 v.03-00)
* Timetable information data feed interface specification ([https://www.rspaccreditation.org/publicDocumentation.php#RSPS5xxx RSPS5046])
* National Routeing Guide data feed specification ([https://www.rspaccreditation.org/publicDocumentation.php#RSPS5xxx RSPS5047])


= Support =
= Support =
If you would like more details on the data, see these references
 
* http://data.atoc.org/fares-data
You may also find the below documentation useful in understanding and using the national routeing guide data set:
* http://data.atoc.org/routeing-guide
 
* http://data.atoc.org/how-to
* [http://datafeeds.rdg.s3.amazonaws.com/RSPS5047/nrg_instructions.pdf Instructions]: Information on how, when and why you should use the National Routeing Guide.
* [http://datafeeds.rdg.s3.amazonaws.com/RSPS5047/nrg_detail.pdf Detail]: More information on how to use the National Routeing Guide, including some step by step examples.
* [http://datafeeds.rdg.s3.amazonaws.com/RSPS5047/nrg_glossary.pdf Glossary]: A list of National Routeing Guide terms and their conditions.
* [http://datafeeds.rdg.s3.amazonaws.com/RSPS5047/nfm64.zip NFM64 Fares]:  NFM64 fares, required for Fares Checking
 
{{Navtable-NreDataFeeds}}
 
[[Category:National Rail Enquiries Data Feeds]]
[[Category:ATOC Data]]

Latest revision as of 13:38, 9 March 2024

Train companies create various types of data associated with the provision of their rail services, including fares, timetable and routeing data. They use this data to provide rail travel information to their customers in a variety of ways, including through approved websites, via mobile phone apps and at their stations through accredited retail systems.

RDG is authorised to make this data available under licence to third parties on behalf of the train companies. Fares, Routeing guide and Timetable data is of a technical nature, and you will require a good level of computer skills in order to be able to process the data.

Fares data consists of product information relating to permanent fares offered by the train operating companies. The data will typically include general fares information such as price, validity, class of travel and restriction information.

Routeing data is created from the information used to specify route validity for certain fares and prescribed customer journey route options.

Timetable data consists of the train service timetable information provided by the train operating companies. The data includes general timetable information such as departure and arrival times for all stations at which a train calls on its journey (e.g. origin, intermediate and terminating).

Accessing Fares, Routeing Guide and Timetable data

To access Fares, Routeing Guide and Timetable data you must have an account on the National Rail Data Portal (NRDP) at https://opendata.nationalrail.co.uk. By creating an account, you can register for a subscription to the Fares, Routeing and Timetable feed.

Important - Please note NRDP accounts expire after extended periods of no use. The unused account expiry period is currently set to 30 days. If you create an account and do not consume any of the feeds during this time your account will be deleted. If your account has been deleted, you will receive a notification email, and you will be able to re-register for a new account.  

Advice on downloading data

Best practice is to check no more than daily for new data.

To determine which file is the latest version, each files header contains the last updated timestamp (response HTTP header, Last-Modified).

NRDP will publish data as received from RDG, on a weekly basis. The data is updated at varying rates.

  • Fares, Routeing Guide and Timetable data - At selected times of the year, RDG will temporarily suspend Fares data publishing. NRDP will continue to make last retrieved file available to NRDP users.
  • Routeing data – weekly
  • Timetable data – Files are rarely updated and Users are advised to poll for updates infrequently

Examples

After selecting the Fares, Routeing Guide and Timetable data subscription type on NRDP, you can receive the files in 2 steps via a rest client by performing the following steps.

  1. Authenticate: Perform HTTP POST call to NRDP via https://opendata.nationalrail.co.uk/authenticate to generate a token.
  2. Download file: Perform HTTP GET call to individual NRDP Feed using the token produced in step 1

Step 1: Generate Authentication Token

See the Authentication section on the National Rail Data Portal article  

Step 2: Perform a HTTP GET call for each file

In this step using a REST client, you would perform a HTTP GET call to each Fares, Routeing Guide and Timetable data files using the token key produced in step 1. This will produce the zip file containing fixed format flat text file(s) for the corresponding Fares, Routeing Guide and Timetable data feeds.

The following are the required links to make the respective HTTP GET call:

The following is an example of request/response for Routeing data via NRDP:

Example HTTP GET Request to NRDP feed: 

GET https://opendata.nationalrail.co.uk/api/staticfeeds/2.0/routeing HTTP/1.1
Content-Type: application/json
Accept: */*
Host: opendata.nationalrail.co.uk
X-Auth-Token: user1@gmail.com:1491312310772:56c56baa3e56d35ff0ede4a6aad1bcfb

Note: X-Auth-Token header value should contain the token from the authenticate response

Corresponding example HTTP 200 Response Header: 

Date: Thu, 22 Nov 2018 13:53:00 GMT
Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips
Last-Modified: Wed, 21 Nov 2018 05:13:43 GMT
Content-Disposition: attachment; filename="RJRG0541.ZIP"
Accept-Ranges: bytes
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/zip
Content-Length: 66021837

Example corresponding fixed format response files:

Each feed returns a zip file with numerous fixed format flat text files. An index file is also provided. For Timetable and Fares data this is the DAT file, for Routeing this is the RGI file.

Example Routeing RGI file (Unzipped): 

   /!! Start of file
   /!! Content type:  index
   /!! Sequence:      0541
   /!! Generated:     07/11/2018
   /!! Exporter:      RJIS RjEhrNRG v0.1
   RJRG0541.RGK
   RJRG0541.RGV
   RJRG0541.RGA
   RJRG0541.RGL
   RJRG0541.RGB
   RJRG0541.RGM
   RJRG0541.RGX
   RJRG0541.RGC
   RJRG0541.RGN
   RJRG0541.RGY	
   RJRG0541.RGD
   RJRG0541.RGE
   RJRG0541.RGP
   RJRG0541.RGF
   RJRG0541.RGG
   RJRG0541.RGR
   RJRG0541.RGH
   RJRG0541.RGS
   /!! End of file (18 records) (07/11/2018)

Example portion of Routeing fixed format file RGRJ0541.RGX (Unzipped) 

   /!! Start of file
   /!! Content type:  new stations
   /!! Sequence:      0541
   /!! Generated:     07/11/2018
   /!! Exporter:      RJIS RjEhrNRG v0.1
   AUR,DAG,01011999,31122999
   AYS,AVP,27112008,31122999
   BCV,SVS,27032014,31122999
   BDI,LMR,07042017,31122999
   BGN,LWM,11052005,31122999
   BGN,RIA,11052005,31122999
   BHG,ARM,09092010,31013000
   BKP,CNP,01011999,31122999
   BON,HWI,21012000,21012999
   BTR,BTP,13112000,13112999

Details on how to interpret the fixed format files can be found in specifications listed below.

  • Fares and associated data feed interface specification (RSPS5045)
  • Timetable information data feed interface specification (RSPS5046)
  • National Routeing Guide data feed specification (RSPS5047)

Support

You may also find the below documentation useful in understanding and using the national routeing guide data set:

  • Instructions: Information on how, when and why you should use the National Routeing Guide.
  • Detail: More information on how to use the National Routeing Guide, including some step by step examples.
  • Glossary: A list of National Routeing Guide terms and their conditions.
  • NFM64 Fares: NFM64 fares, required for Fares Checking


National Rail Enquiries Data Feeds
Data Feeds About the Feeds • Darwin Webservice (Public) • Darwin Webservice (Staff) • Historical Service Performance • Push Port • KnowledgeBase • DTD • Locations (PoC) • Real Time Journey Planner
LDB API About
LDB-SV API About
HSP About
DTD About • Fares • Timetable
Push Port About • XML Schemas • Schedules • Associations • Train Status • Station Messages • Alarms • Train Order • Train Alerts • Formations • Formation loading
Retrieved from "https://wiki.openraildata.com/index.php?title=DTD&oldid=3416"