NRE Darwin Web Service (Staff): Difference between revisions

Latest revision as of 12:09, 6 January 2022

About

The Darwin Web Service (Staff) is a SOAP API which allows access to more detailed information about arrivals and departures from a station. The additional data available includes train reporting numbers (colloquially called 'headcodes'), schedule UIDs and Retail Service IDs (RSID), plus passing points for trains.

This is the same data that is presented on the Darwin Web Service (Public), but in greater detail.

Having problems with the API? Check out the troubleshooting notes.

API

Documentation for the LDB-SV can be found here. A previous edition as a PDF document from May 2016 can be found here: LDB-SV User Guide. Further guidance and advice can be found here LDBSVWS - Guidance Note v1. Whilst last updated in 2014, much of the information is still current and correct. An updated version will be added to this site in due course.

The API uses SOAP, which is not necessarily a developer's first choice. Check out the cross-platform Huxley 2 API proxy, which can be used to put a lightweight JSON endpoint in front of the API.

Example code to consume the service is available for the following languages:

Java using Apache CXF

Detail

The OpenLDB (Staff) provides SOAP 1.1 and 1.2 endpoints which supports the following operations;

Arrivals at a location

Departures from a location

Individual services

Historic data

Reference data

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

@@ Line 9: / Line 9: @@
 == API ==
-Documentation for the LBD-SV can be found here [[File:LDB-SV User Guide.gz]].
+Documentation for the LDB-SV can be found [http://lite.realtime.nationalrail.co.uk/openldbsvws/ here]. A previous edition as a PDF document from May 2016 can be found here: [[Media:LDB-SV User Guide.gz|LDB-SV User Guide]].
-Further guidance and advice can be found here [[File:LDBSVWS - Guidance Note v1.doc.gz]]. Whilst last updated in 2014, much of the information is still current and correct. An updated version will be added to this site in due course.
+Further guidance and advice can be found here [[Media:LDBSVWS - Guidance Note v1.doc.gz|LDBSVWS - Guidance Note v1]]. Whilst last updated in 2014, much of the information is still current and correct. An updated version will be added to this site in due course.
-The API uses [http://en.wikipedia.org/wiki/SOAP SOAP], which is not necessarily a developer's first choice.  Check out the [https://unop.uk/dev/huxley-rail-api-proxy/ Huxley] API proxy, which can be used to put a lightweight JSON endpoint in front of the API.
+The API uses [http://en.wikipedia.org/wiki/SOAP SOAP], which is not necessarily a developer's first choice.  Check out the cross-platform [https://unop.uk/huxley-2-new-updates/ Huxley 2] API proxy, which can be used to put a lightweight JSON endpoint in front of the API.
+Example code to consume the service is available for the following languages:
+* [https://github.com/openraildata/openldbsvws-example-java Java using Apache CXF]
+== Detail ==
 The OpenLDB (Staff) provides SOAP 1.1 and 1.2 endpoints which supports the following operations;
-[[GetArrBoardWithDetails]] <BR>
+=== Arrivals at a location ===
-[[GetArrDepBoardWithDetails]] <BR>
-[[GetArrivalBoardByX | GetArrivalBoardByCRS]] <BR>
+* [[GetArrBoardWithDetails]]
-[[GetArrivalBoardByX | GetArrivalBoardByTIPLOC]] <BR>
+* [[GetArrDepBoardWithDetails]]
-[[GetArrivalDepartureBoardByX | GetArrivalDepartureBoardByCRS]] <BR>
+* [[GetArrivalBoardByX | GetArrivalBoardByCRS]]
-[[GetArrivalDepartureBoardByX | GetArrivalDepartureBoardByTIPLOC]] <BR>
+* [[GetArrivalBoardByX | GetArrivalBoardByTIPLOC]]
-[[GetDepartureBoardByX | GetDepartureBoardByCRS]] <BR>
+* [[GetArrivalDepartureBoardByX | GetArrivalDepartureBoardByCRS]]
-[[GetDepartureBoardByX | GetDepartureBoardByTIPLOC]] <BR>
+* [[GetArrivalDepartureBoardByX | GetArrivalDepartureBoardByTIPLOC]]
-[[GetDepBoardWithDetails]] <BR>
-[[GetFastestDepartures]] <BR>
+=== Departures from a location ===
-[[GetFastestDeparturesWithDetails]] <BR>
-[[GetNextDepartures]] <BR>
+* [[GetDepartureBoardByX | GetDepartureBoardByCRS]]
-[[GetNextDeparturesWithDetails]] <BR>
+* [[GetDepartureBoardByX | GetDepartureBoardByTIPLOC]]
-[[GetServiceDetailsByRID]] <BR>
+* [[GetDepBoardWithDetails]]
-[[QueryServices]] <BR>
+* [[GetFastestDepartures]]
-<BR>
+* [[GetFastestDeparturesWithDetails]]
-[[GetHistoricDepartureBoard]] <BR>
+* [[GetNextDepartures]]
-[[GetHistoricServiceDetails]] <BR>
+* [[GetNextDeparturesWithDetails]]
-[[GetHistoricTimeLine]] <BR>
-[[QueryHistoricServices]] <BR>
+=== Individual services ===
-<BR>
-[[GetSourceInstanceNames]] <BR>
+* [[GetServiceDetailsByRID]]
-[[GetStationList]] <BR>
+* [[QueryServices]]
-[[GetTOCList]] <BR>
-[[GetDisruptionList]] <BR>
+=== Historic data ===
-[[GetReasonCodeList]] <BR>
-[[GetReasonCode]] <BR>
+* [[GetHistoricDepartureBoard]]
+* [[GetHistoricServiceDetails]]
+* [[GetHistoricTimeLine]]
+* [[QueryHistoricServices]]
+=== Reference data ===
+* [[GetSourceInstanceNames]]
+* [[GetStationList]]
+* [[GetTOCList]]
+* [[GetDisruptionList]]
+* [[GetReasonCodeList]]
+* [[GetReasonCode]]
 {{Navtable-NreDataFeeds}}
 [[Category:National Rail Enquiries Data Feeds]]