Darwin:Push Port: Difference between revisions

From Open Rail Data Wiki
m PeterHicks moved page NRE Darwin Push Port to Darwin:Push Port without leaving a redirect: Rename page
m Add Reference Data and Timetable text
Line 13: Line 13:
== Data ==
== Data ==


A Stomp client is required to connect to the service, and an XML parser is required to make use of the data.  [[Darwin:Push_Port_XML_Schemas|XSDs]] for the interface are available.
The Push Port has three components:


Messages are sent individually, not batched, with the message body compressed using gzip.
* Reference Data, available over FTP once a day
* Timetable, available over FTP once a day
* Real-time updates, available over Stomp


A number of elements are sent inside a [[Darwin:uR_Element|update response]] element, which is in turn nested inside a 'Pport' element:
[[Darwin:Push_Port_XML_Schemas|XSDs]] for the interface are available.
 
== Reference Data ==
 
The reference data contains:
 
* TIPLOCs, CRS codes, TOC codes and location names
* TOC codes, names and website URLs
* Late Running reason codes and text
* Cancellation reason codes and text
* Via locations
* CIS codes and names
 
== Timetable ==
 
There are two components to the Darwin Timetable:
 
* A timetable snapshot, available once a day via FTP
* Schedule updates via the Real-time feed (see below)
 
== Real-time Updates ==
 
NOTE: All messages in the real-time update stream are sent in XML with the message body compressed using gzip.
 
Each message in the update feed contains [[Darwin:uR_Element|update response]] element, which is in turn nested inside a 'Pport' element:


* [[Darwin:Schedule_Element|Schedule data]]
* [[Darwin:Schedule_Element|Schedule data]]

Revision as of 15:01, 29 January 2015

About

The Darwin Push Port is an XML push feed that continuously streams information about the creation of, and changes to, train schedule records, together with train running predictions made by Darwin.

The Push Port can be filtered to a specific area of interest by TIPLOC, or to provide information for the entire country. Either way, the information delivered is complex and must be properly interpreted before presentation to end users.

The Push Port requires the user to build a database capable of capturing extremely high volumes of information, as well as a query engine to draw the information from your database. There is a large amount of interpretation work involved in this; however this allows substantial flexibility to apply the information to any product within the limitations of your own infrastructure.

Availability

The Darwin Push Port feed is expected to be available by 31st March 2015.

Data

The Push Port has three components:

  • Reference Data, available over FTP once a day
  • Timetable, available over FTP once a day
  • Real-time updates, available over Stomp

XSDs for the interface are available.

Reference Data

The reference data contains:

  • TIPLOCs, CRS codes, TOC codes and location names
  • TOC codes, names and website URLs
  • Late Running reason codes and text
  • Cancellation reason codes and text
  • Via locations
  • CIS codes and names

Timetable

There are two components to the Darwin Timetable:

  • A timetable snapshot, available once a day via FTP
  • Schedule updates via the Real-time feed (see below)

Real-time Updates

NOTE: All messages in the real-time update stream are sent in XML with the message body compressed using gzip.

Each message in the update feed contains update response element, which is in turn nested inside a 'Pport' element: