Thales technical document - National · Web viewGetting Started Standards Compliance The API...

PROJECT 825PROJECTTITLE

OPTIONAL PROJECT SUBTITLE

OJP WEB SERVICESDisruption Services

User Guide

P82571040 Issue 5 12 September 2014

Originator’s signature & date Approver’s signature and date

Thales Development Thales Design Authority

Thales, Ashurst Drive, Bird Hall Lane, Cheadle Heath, Stockport, Cheshire SK3 0XB, UKTel: +44 (0)161 491 4001•Fax: +44 (0)161 741 3704•[email protected]•www.thalesgroup.com

© 2015 Thales Transport & Security Ltd - This document is the copyright of Thales Transport & Security Ltd and is issued in confidence. It must not be used other than for the purposes of the contract to which it relates and is not to be reproduced in whole or in part without the prior written permission of Thales Transport & Security Ltd.

DISTRIBUTION

1 Project Master File2 NRE Copy 13 NRE Copy 24 Thales Design Authority

ISSUE RECORD

Issue Date Purpose

1 02/02/2012

First Issue, covers the Frontline Disruptions web service

2a 01/05/2014

Updated with CR 01096 Enhanced Disruptions Web Service

2b 23/05/2014

Updated with Issue 2a review corrections

Updated with CR 01470 National Service Indicator

2 27/05/2014

Pagination improved, raised to Issue

3 18/06/2014

Web Service Function names and descriptions included

4a 11/07/2014

Clarified that only the latest vesion of Incidents are returned

4b 21/07/2014

Updated with comments from NRE review

4 05/09/2014

Raised to Issue following NRE approval

5a 12/09/2014

Formatted XML examples

5 12/09/2014

Raised to Issue

P82571040 Issue 5 ii

CONTENTS

1. INTRODUCTION 1

2. GETTING STARTED 1

2.1 Standards Compliance 12.2 Development Platforms 12.3 Importing the WSDL(s) into your Development Environment 12.3.1 Instructions for Java Environments (Apache Axis) 22.3.2 Instructions for Microsoft Visual Studio 2

3. AUTHENTICATION 4

4. AVAILABLE OPERATIONS 4

5. API 6

5.1 WSDL (Web Service Definition Language) 65.2 Selection of Operation 65.3 Message Types 65.4 Primitive Data Types 75.5 Namespaces 75.6 Internationalisation and Character Sets 75.7 XML Compliance 75.8 Characteristics of API Calls 8

6. DISRUPTION BY DATE AND OPERATOR CODE (DISRUPTION) 9

6.1 Overview 9

7. DISRUPTION FOR SPECIFIC INCIDENT (DISRUPTIONFORSPECIFICIN)10

7.1 Overview 107.2 Request Type 107.3 Response Type 107.4 Error Handling 107.5 Request Example 107.6 Response Example 10

8. DISRUPTION FOR DATE RANGE (DISRUPTIONBYDATES) 12

8.1 Overview 128.2 Request Type 128.3 Response Type 128.4 Error Handling 128.5 Request Example 13

P82571040 Issue 5 iii

8.6 Response Example 13

9. DISRUPTION FOR STATION CRS (DISRUPTIONBYSTATIONCRS) 16


10. STATION MESSAGES (STATIONMESSAGE) 19


11. BULLETIN 21


12. ALL TYPE OF DISRUPTION FOR STATION CRS (ALLDISRUPTIONINFORMATION) 25


13. SERVICE INDICATOR FOR TOC (SERVICEINDICATORFORTOC) 29

13.1 Overview 2913.2 Request Type 2913.3 Response Type 2913.4 Error Handling 2913.5 Request example 2913.6 Response Example 29

14. SERVICE INDICATOR FOR ALL TOCS (SERVICEINDICATORFORALLTOCS) 31

14.1 Overview 3114.2 Request Type 31

P82571040 Issue 5 iv

14.3 Response Type 3114.4 Request Example 3114.5 Response Example 31

P82571040 Issue 5 v

P82571040 Issue 5 vi

OJP WEB SERVICESDISRUPTION SERVICES

USER GUIDE

1. Introduction

This user guide describes how to write client calls for the Disruptions Web Service.

2. Getting Started

2.1 Standards Compliance

The API is implemented to comply with the following specifications:

Standard Name VersionWebsite

Simple Object Access Protocol (SOAP).

1.1 http://www.w3.org/TR/2000/NOTE-SOAP-20000508/

Web Service Description Language (WSDL)

1.1 http://www.w3.org/TR/2001/NOTE-wsdl-20010315

2.2 Development Platforms

The API works with current SOAP development environments, including, but not limited to, Spring, Apache Axis and Microsoft Visual Studio 2008 (.NET). For more information about Spring Web Services see http://static.springsource.org/spring-ws/sites/2.0/. For more information about Apache Axis 1.4, go to http://ws.apache.org/axis/. For more information about Microsoft Visual Studio see http://msdn.microsoft.com/en-us/vstudio/default.aspx.

2.3 Importing the WSDL(s) into your Development Environment

Once you have the WSDL file, you need to import it into your development platform so that your development environment can generate the necessary objects for use in building client Web service applications in that environment. This section provides sample instructions for Apache Axis and Microsoft Visual Studio. For instructions about other development platforms, see your platform’s product documentation.

P82571040 Issue 5a 1

2.3.1 Instructions for Java Environments (Apache Axis)

Java environments access the API through Java objects that serve as proxies for their server-side counterparts. Before using the API, you must first generate these objects from your the WSDL file(s).

Each SOAP client has its own tool for this process. For Apache Axis, use the WSDL2Java utility.

Before you run WSDL2Java, you must have Axis installed on your system and all of its component JAR files must be referenced in your classpath.

The basic syntax for WSDL2Java is:

java –classpath pathToJAR/Filename org.apache.axis.wsdl.WSDL2Java -a pathToWsdl/WsdlFilename

The -a switch generates code for all elements, referenced or not, which may be necessary depending on your WSDL. For more information, see the WSDL2Java documentation.

If you have JAR files in more than one location, list them with a semicolon separating the files. For example, if the Axis JAR files are installed in C:\axis-1.3, and the WSDL is named my.wsdl and is stored in C:\mywsdls:

java –classpath c:\axis-1.3\lib\axis.jar;c:\axis-1.3\lib\axis-ant.jar;c:\axis-1.3\lib\axis-schema.jar;?c:\axis-1.3\lib\commons-discovery-0.2.jar;c:\axis-1.3\lib\commons-logging-1.0.4.jar;?c:\axis-1.3\lib\jaxrpc.jar;c:\axis-1.3\lib\log4j-1.2.8.jar;c:\axis-1.3\lib\saaj.jar;?c:\axis-1.3\lib\wsdl4j-1.5.2.jar;c:\axis-1.3\mail.jar;c:\axis-1.3\activation.jar;c:\axis-1.3\wsdl4j.jar; org.apache.axis.wsdl.WSDL2Java -a C:\mywsdls\my_enterprise.wsdl

This command will generate a set of folders and Java source code files in the same directory in which it was run. After these files are compiled, they can be included in your Java programs for use in creating client applications.

For most Java development environments, you can use wizard-based tools for this process instead of the command line. For more information about using WSDL2Java, see http://ws.apache.org/axis/java/reference.html.

2.3.2 Instructions for Microsoft Visual Studio

Visual Studio languages access the API through objects that serve as proxies for their server-side counterparts. Before using the API, you must first generate these objects from your the WSDL file(s).

Visual Studio provides two approaches for importing your WSDL file and generating an XML Web service client: an IDE-based approach and a command line approach.

An XML Web service client is any component or application that references and uses an XML Web service. This does not necessarily need to be a client-based application. In fact, in many cases, your XML Web service clients might be other Web applications, such as Web Forms or even other XML Web services. When accessing XML Web services in managed code, a proxy class and the .NET Framework handle all of the infrastructure coding.

P82571040 Issue 5a 2

To access an XML Web service from managed code:

1. Add a Web reference to your project for the XML Web service that you want to access. The Web reference creates a proxy class with methods that serve as proxies for each exposed method of the XML Web service.

2. Add the namespace for the Web reference.

3. Create an instance of the proxy class and then access the methods of that class as you would the methods of any other class.

To add a Web reference:

1. On the Project menu, choose Add Web Reference.

2. In the URL box of the Add Web Reference dialog box, type the URL to obtain the service description of the XML Web service you want to access, such as:

file:///c:\WSDLFiles\my.wsdl

3. Click Go to retrieve information about the XML Web service.

4. In the Web reference name box, rename the Web reference to the appropriate namespace - the namespace you will use for this Web reference.

5. Click Add Reference to add a Web reference for the target XML Web service. For more information, see the topic “Adding and Removing Web References” in the Visual Studio documentation.

6. Visual Studio retrieves the service description and generates a proxy class to interface between your application and the XML Web service.

P82571040 Issue 5a 3

3. Authentication

There are two types of authentication possible for accessing these web services :

IP White Listing

Username/password

The choice of which to use will depend on what application the web services are required for. In the case of an application running in a server environment and calling the web services from a specific place then IP White Listing can be used. A typical setup here would be another web site that wants to include information from OJP.

Where the web services will be called from many different IP addresses then the recommended setup is username/password. A typical setup here would be a smartphone application.

Note the above two options only apply to the OJP live environment.. If National Rail Enquiries permits access to the staging environment then both a specific IP address will be required from you and a username/password will be provided to you.

If you are given a username/password this must be sent as part of the HTTP transaction. The exact method of adding this is dependant upon the client side framework that you are using but a good page that describes it can be found at http://en.wikipedia.org/wiki/Basic_access_authentication

4. Available Operations

The following table lists the available operations for the Disruptions Web Service.

Operation Usage

Disruption Requests a list of current disruptions (note that this function is only available for the Frontline Blackberry App)

Bulletins Return one or more incidents for the supplied date and operator code(s)

StationMessage Returns all station messages for the supplied Station

DisruptionForSpecificIN

Returns disruption information for a specified incident number

P82571040 Issue 5a 4

DisruptionByDates Returns all valid disruptions between the supplied dates

DisruptionByStationCrs Returns all valid disruptions for the specified station

AllDisruptionInformation

Returns Station Messages, Bulletins, Disruptions and the National Service Indicator for the specified station

ServiceIndicatorForToc Returns the National Service Indicator data for the specified TOC

ServiceIndicatorForAllTocs

Returns the National Service Indicator data for all TOCs.

P82571040 Issue 5a 5

5. API

5.1 WSDL (Web Service Definition Language)

The WSDL file(s) defines the API for the Web services. It can be found at http://ojp.nationalrail.co.uk/webservices/dis.wsdl . (You will only be able to access this once your account has been setup)

There are comments within the WSDL itself to explain some of the specific fields in a bit more detail.

5.2 Selection of Operation

With Web service SOAP messages there are different methods of determining which operation to invoke. For all Web services described in this document the operation to invoke is determined based on the message payload content. It is not necessary to specify the operation explicitly in the SOAP header. Thus, for example, if a Bulletin object is passed in the SOAP body then the Bulletin operation will be invoked.

5.3 Message Types

Operation Input Message Type Output Message Type

Disruption by date and operator code

DisruptionRequestType DisruptionResponseType

Disruption for specific incident number

DisruptionForSpecificINRequestType

DisruptionForSpecificINResponseType

Disruption for date range

DisruptionByDatesRequestType DisruptionByDatesResponseType

Disruption for station CRS

DisruptionByStationCrsRequestType

DisruptionByStationCrsResponseType

Station messages

StationMessageRequestType StationMessageResponseType

Bulletin BulletinRequestType BulletinResponseType

All type of disruption for

AllDisruptionInformationRequest AllDisruptionInformationRequest

P82571040 Issue 5a 6

http://ojp.nationalrail.co.uk/webservices/disjpdlr.wsdl

station CRS Type Type

Service indicator for Toc

ServiceIndicatorForTocRequest ServiceIndicatorForTocResponse

Service indicator for all tocs

ServiceIndicatorForAllTocsRequest

ServiceIndicatorForAllTocsResponse

5.4 Primitive Data Types

Primitive data types are basic types such as string, dateTime, integer and NMTOKEN.

These are specified in the World Wide Web Consortium’s publication XML Schema Part 2: Data Types at the following URL: http://www.w3.org/TR/xmlschema-2/.

5.5 Namespaces

Namespaces for use with XML tags are specified in the WSDL file(s). When making client calls using the API these namespaces must be included in the request XML.

5.6 Internationalisation and Character Sets

The API supports either the full Unicode character set.

5.7 XML Compliance

The API is based on XML, which requires all documents to be well formed. Part of that requirement is that certain Unicode characters are not allowed in an XML document, even in an escaped form, and that others must be encoded according to their location. Normally any standard SOAP or XML client handles this for you. Clients must be able to parse any normal XML escape sequence, and must not pass up invalid XML characters.

Some characters, as mentioned, are illegal even if they are escaped. The illegal characters include the Unicode surrogate blocks and a few other Unicode characters. All are seldom-used control characters that are usually not important in any data, and tend to cause problems with many programs. Although they are not allowed in XML documents, they are allowed in HTML documents and may be present in some data. The illegal characters will be stripped from any API response.

The following characters are illegal:

P82571040 Issue 5a 7

0xFFFE

0xFFFF

Control characters 0x0 - 0x19, except the following characters, which are legal: 0x9, 0xA, 0xD, tab, new line, and carriage return)

0xD800 - 0xDFFFFor more information about XML characters and character sets0 see http://www.w3.org/TR/REC-xml#charsets.

5.8 Characteristics of API Calls

All API calls are:

Service Requests and Responses. Your client application prepares and submits a service request to the Web Service via the API, the Web Service processes the request and returns a response, and the client application handles the response.

Synchronous. Once the API call is invoked, your client application waits until it receives a response from the service. Asynchronous calls are not supported.

Committed Atomically. Every operation that writes data is committed atomically and automatically. Therefore an operation always succeeds entirely or fails – it never partially succeeds.

P82571040 Issue 5a 8

6. Disruption by Date and Operator Code (Disruption)

6.1 Overview

The Disruption function is provided for the Blackberry Frontline App (NRE Staff App) and should not be used by any other application. Please refer to NRE if you believe you need information regarding this function.

P82571040 Issue 5a 9

7. Disruption for Specific Incident (DisruptionForSpecificIN)

7.1 Overview

The DisruptionForSpecificIN function returns disruption information for a specified incident number.

7.2 Request Type

The following elements are supplied to the web service:

Element Description Required Multiple Representation

Incident Number Incident number for specific incident Yes Yes

7.3 Response Type

The data returned by this Web Service is based on data originally supplied by NRE. The web service constantly updates its records of current incidents based on this information.

The web service returns either one or no incident for the supplied Incident Number(s). Only the latest incident for the supplied incident number will be returned.

7.4 Error Handling

If there is no incident associated with supplied incident number, then that incident number is treated as invalid incident number.

If the same, valid, incident number is supplied more than once in the request, the web service will return the same disruption multiple times without any validation.

7.5 Request Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dis="http://www.thalesgroup.com/ojp/dis"> <soapenv:Header/> <soapenv:Body> <dis:DisruptionForSpecificINRequest> <dis:incidentNumber>FFB8032F108948FB9BB1D8414AA6F148</dis:incidentNumber> <dis:incidentNumber>FFB8032F108948FB9BB1D8414INVALID</dis:incidentNumber> </dis:DisruptionForSpecificINRequest> </soapenv:Body></soapenv:Envelope>

P82571040 Issue 5a 10

7.6 Response Example

8. Disruption for Date Range (DisruptionByDates)

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body> <ns2:DisruptionForSpecificINResponse

xmlns:ns2="http://www.thalesgroup.com/ojp/dis"xmlns:ns3="http://www.thalesgroup.com/ojp/commonDisruption">

<ns2:invalidIncidentNumbers>

<ns2:invalidIncidentNumber>FFB8032F108948FB9BB1D8414INVALID</ns2:invalidIncidentNumber>

</ns2:invalidIncidentNumbers><ns2:disruption>

<ns3:creationTime>2014-01-16T11:20:00.000Z</ns3:creationTime><ns3:lastChangedDate>2014-02-17T10:34:00.000Z</ns3:lastChangedDate><ns3:description><![CDATA[Engineering work is taking place between

Linlithgow / Polmont and Falkirk High / Falkirk Grahamston with various line closures.East CoastOn Sunday trains will be diverted and not call at Falkirk Grahamston, Stirling and

Gleneagles, buses will run between Edinburgh and Perth calling at stations normally served by the train.

ScotRailSaturdayTrain services between Glasgow Queen Street and Edinburgh (via Falkirk High) are

diverted, retimed and reduced to operate half-hourly, in both directions. They will not call at Falkirk High, instead they will call at Falkirk Grahamston, Polmont and Linlithgow. Connecting buses will run between Falkirk Grahamston and Falkirk High. 

SundayTrain services between Glasgow Queen Street and Edinburgh (via Falkirk High) are

diverted and will terminate at Falkirk Grahamston, connecting buses will run to and from Edinburgh. Connecting bus will run between Falkirk Grahamston and Falkirk High. 

The 23:00 and 23:00 from Edinburgh to Glasgow Queen Street will be buses also calling at Haymarket, Linlithgow, Polmont, Falkirk High, Croy. 

Train services between Perth / Dunblane / Stirling and Edinburgh will run terminate at Falkirk Grahamston, connecting buses will run to and from Edinburgh.

The 20:26 Inverness to London Euston sleeper service is diverted after Perth via Fife, and will no longer call at Gleneagles, Dunblane, Stirling and Falkirk Grahamston. 

Planning your JourneyFor full details of these changes and

the impact on your journey, please use the National Rail Enquiries <a href="http://ojp.nationalrail.co.uk/">Journey Planner</a>]]></ns3:description>

<ns3:equipmentReason>MAINTENANCE_WORK</ns3:equipmentReason>

<ns3:incidentNumber>FFB8032F108948FB9BB1D8414AA6F148</ns3:incidentNumber>

<ns3:participantRef>FFB8032F108948FB9BB1D8414AA6F148</ns3:participantRef><ns3:planned>true</ns3:planned><ns3:summary>Amended service between Linlithgow / Polmont and Falkirk

High / Falkirk Grahamston on Saturday 5 and Sunday 6 April 2014</ns3:summary><ns3:disruptionVersion>20140217103400</ns3:disruptionVersion><ns3:changedBy>pthomas</ns3:changedBy><ns3:ojpVersion>3</ns3:ojpVersion><ns3:infoLinks>

<ns3:label>Additional Maps</ns3:label>

<ns3:uri>http://www.nationalrail.co.uk/static/documents/maps/Linlithgow_Falkirk.pdf</ns3:uri>P82571040 Issue 5a 11

</ns3:infoLinks><ns3:infoLinks><ns3:label>nationalrail.co.uk</ns3:label><ns3:uri>http://www.nationalrail.co.uk/service_disruptions/69227.aspx</

ns3:uri></ns3:infoLinks><ns3:networks>

<ns3:affectedRoute>East Coast between London Kings Cross and Inverness.

ScotRail between Glasgow Queen Street and Edinburgh also Dunblane / Stirling and Edinburgh.</ns3:affectedRoute>

</ns3:networks><ns3:operators>

<ns3:name>First ScotRail</ns3:name><ns3:ref>SR</ns3:ref>

</ns3:operators><ns3:operators>

<ns3:name>East Coast</ns3:name><ns3:ref>GR</ns3:ref>

</ns3:operators><ns3:progress>open</ns3:progress><ns3:validityPeriod>

<ns3:startTime>2014-04-05T01:00:00.000+01:00</ns3:startTime><ns3:endTime>2014-04-07T00:59:00.000+01:00</ns3:endTime>

</ns3:validityPeriod></ns2:disruption>

</ns2:DisruptionForSpecificINResponse></SOAP-ENV:Body>

</SOAP-ENV:Envelope>

8.1 Overview

The DisruptionByDates function returns all valid disruptions between the supplied dates, optionally filtered to only include disruptions

affecting a specified Operator(s)

that are planned (Engineering Works) or unplanned (Disruptions).

If no filtering is specified in the request, the function returns all disruptions (planned and unplanned) for all operators valid between the supplied dates.

8.2 Request Type



Start Date Start Date to find disruption Yes No

End Date End Date to find disruption Yes No

Operator Code(s) Operators affected by incidents No Yes

Disruption Type Engineering Works / Disruptions filter No No

P82571040 Issue 5a 12

8.3 Response Type


Incidents may be updated several times before they are resolved. In such cases, only the latest version of the unplanned incident is returned if the incident matches the supplied criteria.

8.4 Error Handling

There are no defined error responses. If the request passes validation, and erroneous data is supplied (e.g. unknown operator code), then the standard response will be returned.

8.5 Request Example

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:dis="http://www.thalesgroup.com/ojp/dis">

<soapenv:Header/> <soapenv:Body> <dis:DisruptionByDatesRequest> <dis:startDate>2014-04-04</dis:startDate> <dis:endDate>2014-04-05</dis:endDate> <dis:operatorCode>SR</dis:operatorCode> </dis:DisruptionByDatesRequest> </soapenv:Body></soapenv:Envelope>


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:DisruptionByDatesResponse

xmlns:ns2="http://www.thalesgroup.com/ojp/dis"xmlns:ns3="http://www.thalesgroup.com/ojp/commonDisruption">

<ns2:disruption> <ns3:creationTime>2014-01-16T11:20:00.000Z</ns3:creationTime> <ns3:lastChangedDate>2014-02-17T10:34:00.000Z</ns3:lastChangedDate> <ns3:description><![CDATA[Engineering work is taking place between Linlithgow / Polmont and Falkirk High / Falkirk Grahamston with various line closures. East Coast On Sunday trains will be diverted and not call at Falkirk Grahamston, Stirling and Gleneagles, buses will run between Edinburgh and Perth calling at stations normally served by the train. ScotRail Saturday Train services between Glasgow Queen Street and Edinburgh (via Falkirk High) are diverted, retimed and reduced to operate half-hourly, in both directions. They will not call at Falkirk High, instead they will call at Falkirk Grahamston, Polmont and Linlithgow. Connecting buses will run between Falkirk Grahamston and Falkirk High. Sunday

P82571040 Issue 5a 13

Train services between Glasgow Queen Street and Edinburgh (via Falkirk High) are diverted and will terminate at Falkirk Grahamston, connecting buses will run to and from Edinburgh. Connecting bus will run between Falkirk Grahamston and Falkirk High. The 23:00 and 23:00 from Edinburgh to Glasgow Queen Street will be buses also calling at Haymarket, Linlithgow, Polmont, Falkirk High, Croy. Train services between Perth / Dunblane / Stirling and Edinburgh will run terminate at Falkirk Grahamston, connecting buses will run to and from Edinburgh. The 20:26 Inverness to London Euston sleeper service is diverted after Perth via Fife, and will no longer call at Gleneagles, Dunblane, Stirling and Falkirk Grahamston. Planning your Journey For full details of these changes and the impact on your journey, please use the National Rail Enquiries <a href="http://ojp.nationalrail.co.uk/">Journey Planner</a>]]></ns3:description> <ns3:equipmentReason>MAINTENANCE_WORK</ns3:equipmentReason> <ns3:incidentNumber>FFB8032F108948FB9BB1D8414AA6F148</ns3:incidentNumber> <ns3:participantRef>FFB8032F108948FB9BB1D8414AA6F148</ns3:participantRef> <ns3:planned>true</ns3:planned> <ns3:summary>Amended service between Linlithgow / Polmont and Falkirk High / Falkirk Grahamston on Saturday 5 and Sunday 6 April 2014</ns3:summary> <ns3:disruptionVersion>20140217103400</ns3:disruptionVersion> <ns3:changedBy>pthomas</ns3:changedBy> <ns3:ojpVersion>3</ns3:ojpVersion> <ns3:infoLinks> <ns3:label>Additional Maps</ns3:label> <ns3:uri>http://www.nationalrail.co.uk/static/documents/maps/Linlithgow_Falkirk.pdf</ns3:uri> </ns3:infoLinks> <ns3:infoLinks> <ns3:label>nationalrail.co.uk</ns3:label> <ns3:uri>http://www.nationalrail.co.uk/service_disruptions/69227.aspx</ns3:uri> </ns3:infoLinks> <ns3:networks> <ns3:affectedRoute>East Coast between London Kings Cross and Inverness. ScotRail between Glasgow Queen Street and Edinburgh also Dunblane / Stirling and Edinburgh.</ns3:affectedRoute> </ns3:networks> <ns3:operators> <ns3:name>First ScotRail</ns3:name> <ns3:ref>SR</ns3:ref> </ns3:operators> <ns3:operators> <ns3:name>East Coast</ns3:name> <ns3:ref>GR</ns3:ref> </ns3:operators> <ns3:progress>open</ns3:progress> <ns3:validityPeriod> <ns3:startTime>2014-04-05T01:00:00.000+01:00</ns3:startTime> <ns3:endTime>2014-04-07T00:59:00.000+01:00</ns3:endTime> </ns3:validityPeriod> </ns2:disruption> <ns2:disruption> <ns3:creationTime>2014-01-16T11:20:00.000Z</ns3:creationTime> <ns3:lastChangedDate>2014-01-28T13:40:00.000Z</ns3:lastChangedDate> <ns3:description><![CDATA[Engineering work is taking place between Linlithgow / Polmont and Falkirk High / Falkirk Grahamston with various line closures. East Coast On Sunday trains will be diverted and not call at Falkirk Grahamston, Stirling and Gleneagles, buses will run between Edinburgh and Perth calling at stations normally served by the train. ScotRailP82571040 Issue 5a 14

Saturday Train services between Glasgow Queen Street and Edinburgh (via Falkirk High) are diverted, retimed and reduced to operate half-hourly, in both directions. They will not call at Falkirk High, instead they will call at Falkirk Grahamston, Polmont and Linlithgow. Connecting buses will run between Falkirk Grahamston and Falkirk High. Sunday Train services between Glasgow Queen Street and Edinburgh (via Falkirk High) are diverted and will terminate at Falkirk Grahamston, connecting buses will run to and from Edinburgh. Connecting bus will run between Falkirk Grahamston and Falkirk High. The 23:00 and 23:00 from Edinburgh to Glasgow Queen Street will be buses also calling at Haymarket, Linlithgow, Polmont, Falkirk High, Croy. Train services between Perth / Dunblane / Stirling and Edinburgh will run terminate at Falkirk Grahamston, connecting buses will run to and from Edinburgh. The 20:26 Inverness to London Euston sleeper service is diverted after Perth via Fife, and will no longer call at Gleneagles, Dunblane, Stirling and Falkirk Grahamston. Planning your Journey For full details of these changes and the impact on your journey on Sunday, please use the National Rail Enquiries <a href="http://ojp.nationalrail.co.uk/">Journey Planner</a> The changes for Saturday are not currently shown in the National Rail Enquiries Journey Planner, please check back nearer to the time of travel.]]></ns3:description> <ns3:equipmentReason>MAINTENANCE_WORK</ns3:equipmentReason> <ns3:incidentNumber>FFB8032F108948FB9BB1D8414AA6F148</ns3:incidentNumber> <ns3:participantRef>FFB8032F108948FB9BB1D8414AA6F148</ns3:participantRef> <ns3:planned>true</ns3:planned> <ns3:summary>Amended service between Linlithgow / Polmont and Falkirk High / Falkirk Grahamston on Saturday 5 and Sunday 6 April 2014</ns3:summary> <ns3:disruptionVersion>20140128134000</ns3:disruptionVersion> <ns3:changedBy>CShepherd</ns3:changedBy> <ns3:ojpVersion>2</ns3:ojpVersion> <ns3:infoLinks> <ns3:label>Additional Maps</ns3:label> <ns3:uri>http://www.nationalrail.co.uk/static/documents/maps/Linlithgow_Falkirk.pdf</ns3:uri> </ns3:infoLinks> <ns3:infoLinks> <ns3:label>nationalrail.co.uk</ns3:label> <ns3:uri>http://www.nationalrail.co.uk/service_disruptions/69227.aspx</ns3:uri> </ns3:infoLinks> <ns3:networks> <ns3:affectedRoute>East Coast between London Kings Cross and Inverness. ScotRail between Glasgow Queen Street and Edinburgh also Dunblane / Stirling and Edinburgh.</ns3:affectedRoute> </ns3:networks> <ns3:operators> <ns3:name>First ScotRail</ns3:name> <ns3:ref>SR</ns3:ref> </ns3:operators> <ns3:operators> <ns3:name>East Coast</ns3:name> <ns3:ref>GR</ns3:ref> </ns3:operators> <ns3:progress>open</ns3:progress> <ns3:validityPeriod> <ns3:startTime>2014-04-05T01:00:00.000+01:00</ns3:startTime> <ns3:endTime>2014-04-07T00:59:00.000+01:00</ns3:endTime> </ns3:validityPeriod> </ns2:disruption> </ns2:DisruptionByDatesResponse> </SOAP-ENV:Body>P82571040 Issue 5a 15

</SOAP-ENV:Envelope>

P82571040 Issue 5a 16

9. Disruption for Station CRS (DisruptionByStationCrs)

9.1 Overview

The DisruptionByStationCrs function returns all valid disruptions for the station specified by CRS code.

9.2 Request Type



Station CRS CRS code for station Yes Yes

9.3 Response Type



9.4 Error Handling

Web service verifies supplied CRS are valid or not, and invalid station CRS will be returned in the response under invalid CRS section.

9.5 Request Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dis="http://www.thalesgroup.com/ojp/dis"> <soapenv:Header/> <soapenv:Body> <dis:DisruptionByStationCrsRequest> <dis:stationCrs>MAN</dis:stationCrs> <dis:stationCrs>EUS</dis:stationCrs> <dis:stationCrs>BIT</dis:stationCrs> <dis:stationCrs>123</dis:stationCrs> </dis:DisruptionByStationCrsRequest> </soapenv:Body></soapenv:Envelope>


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body>

P82571040 Issue 5a 17

<ns2:DisruptionByStationCrsResponse xmlns:ns2="http://www.thalesgroup.com/ojp/dis" xmlns:ns3="http://www.thalesgroup.com/ojp/commonDisruption"> <ns2:invalidCrsSupplied> <ns3:stationCRS>123</ns3:stationCRS> </ns2:invalidCrsSupplied> <ns2:disruptionsForCrs> <ns2:stationCRS>BIT</ns2:stationCRS> <ns2:disruptions> <ns3:disruption> <ns3:creationTime>2013-11-25T13:52:00.000Z</ns3:creationTime> <ns3:lastChangedDate>2014-02-19T15:26:00.000Z</ns3:lastChangedDate> <ns3:description><![CDATA[Chiltern Railways in partnership with Network Rail, are investing £130 million in building a new rail link between Oxford and London Marylebone.This will include:<ul><li>Laying almost a mile of new track between Bicester Town to just south of Bicester North to join the main line between Birmingham and London Marylebone <li>Renewal of existing track and signalling equipment <li>A new station between Oxford and Islip called Oxford Parkway </li></ul>From summer 2015 Chiltern Railways will introduce a new service between London Marylebone and Oxford Parkway.From spring 2016 these services will begin to run from the centre of Oxford. For further information please click <a href="http://www.chilternrailways.co.uk/bicester-oxford">here</a> or <a href="http://www.networkrail.co.uk/east-west-rail/?cd=1">here.</a><SPAN lang=EN-GB

P82571040 Issue 5a 18

sizset="29" sizcache0000058462902430111985="0" sizcache05811793301760391="0" sizcache0013275274648660073="0" sizcache06481758114208709="0">To allow this improvement work to take place the line between Oxford and Bicester Town will be closed until summer 2015, as a result buses will replace trains between Oxford and Bicester Town.Planning your JourneyFor full details of these changes and the impact on your journey, please use the National Rail Enquiries <a href="http://ojp.nationalrail.co.uk/">Journey Planner</a>]]></ns3:description> <ns3:equipmentReason>MAINTENANCE_WORK</ns3:equipmentReason> <ns3:incidentNumber>E85348624A0D432494443ADE6F479F26</ns3:incidentNumber> <ns3:participantRef>E85348624A0D432494443ADE6F479F26</ns3:participantRef> <ns3:planned>true</ns3:planned> <ns3:summary>Buses replace trains between Oxford and Bicester Town until Summer 2015</ns3:summary> <ns3:disruptionVersion>20140219152600</ns3:disruptionVersion> <ns3:changedBy>pthomas</ns3:changedBy> <ns3:ojpVersion>13</ns3:ojpVersion> <ns3:infoLinks> <ns3:label>nationalrail.co.uk</ns3:label> <ns3:uri>http://www.nationalrail.co.uk/service_disruptions/62816.aspx</ns3:uri> </ns3:infoLinks> <ns3:infoLinks> <ns3:label>Additional Maps</ns3:label>

<ns3:uri>http://www.nationalrail.co.uk/static/documents/maps/Oxford_Bicester_Town(2).pdf</ns3:uri>

</ns3:infoLinks> <ns3:networks> <ns3:affectedRoute>Trains between Oxford and Bicester Town</ns3:affectedRoute> </ns3:networks> <ns3:operators> <ns3:name>Chiltern Railways</ns3:name> <ns3:ref>CH</ns3:ref> </ns3:operators> <ns3:progress>open</ns3:progress> <ns3:validityPeriod> <ns3:startTime>2014-02-15T00:00:00.000Z</ns3:startTime> <ns3:endTime>2015-05-09T00:59:00.000+01:00</ns3:endTime>P82571040 Issue 5a 19

</ns3:validityPeriod> </ns3:disruption> </ns2:disruptions> </ns2:disruptionsForCrs> <ns2:disruptionsForCrs> <ns2:stationCRS>EUS</ns2:stationCRS> </ns2:disruptionsForCrs> <ns2:disruptionsForCrs> <ns2:stationCRS>MAN</ns2:stationCRS> </ns2:disruptionsForCrs> </ns2:DisruptionByStationCrsResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

P82571040 Issue 5a 20

10. Station Messages (StationMessage)

10.1 Overview

The StationMessage function returns all station messages for the Station specified by CRS code.

10.2 Request Type




10.3 Response Type

The data returned by this web service is based on data originally supplied by Darwin, and also extracted from the Stations.XML file sourced from KB.

10.4 Error Handling

Web service verifies supplied CRS are valid or not, and invalid station CRS will be returned in the response under invalid CRS section.

10.5 Request Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dis="http://www.thalesgroup.com/ojp/dis"> <soapenv:Header/> <soapenv:Body> <dis:StationMessageRequest> <dis:stationCrs>BIT</dis:stationCrs> <dis:stationCrs>123</dis:stationCrs> <dis:stationCrs>PLY</dis:stationCrs> <dis:stationCrs>OXF</dis:stationCrs> </dis:StationMessageRequest> </soapenv:Body></soapenv:Envelope>


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:StationMessageResponse xmlns:ns2="http://www.thalesgroup.com/ojp/dis" xmlns:ns3="http://www.thalesgroup.com/ojp/commonDisruption" xmlns:ns4="http://www.thalesgroup.com/ojp/commonStationMessages"> <ns2:invalidCrsSupplied> <ns3:stationCRS>123</ns3:stationCRS> </ns2:invalidCrsSupplied> <ns2:stationMessages>

P82571040 Issue 5a 21

<ns4:stationMessage> <ns4:stationCRS>BIT</ns4:stationCRS> <ns4:creationTime>2014-05-01T09:01:20.274+01:00</ns4:creationTime> <ns4:stationDistruption> <ns4:category>STATION</ns4:category> <ns4:severity>MINOR</ns4:severity> <ns4:xHtmlMessage>Because of engineering work, there are no train services at this station until Summer 2015. More details are available from the Current Engineering Work area of the <A href="http://nationalrail.co.uk/service_disruptions/62816.aspx">National Rail Enquiries website</A>.</ns4:xHtmlMessage> <ns4:description>E: Until Summer 2015</ns4:description> </ns4:stationDistruption> </ns4:stationMessage> <ns4:stationMessage> <ns4:stationCRS>PLY</ns4:stationCRS> <ns4:creationTime>2014-05-01T09:01:20.274+01:00</ns4:creationTime> </ns4:stationMessage> <ns4:stationMessage> <ns4:stationCRS>OXF</ns4:stationCRS> <ns4:creationTime>2014-05-01T09:01:20.274+01:00</ns4:creationTime> </ns4:stationMessage> </ns2:stationMessages> </ns2:StationMessageResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

P82571040 Issue 5a 22

11. Bulletin

11.1 Overview

The Bulletin function returns all valid bulletins that match the list of supplied filters.

11.2 Request Type



Station CRS Filters the response to only return bulletins with specified CRS code for station

Value can be valid CRS for station.

No Yes

EffectiveAt Filters the response to only return bulletins active at EffectiveAt time.

Any date can be passed as value.

No No

IsAlertValue Filters the response to only return bulletins for specified value for IsAlert.

value can be true or false.

No No

IsDisruptionValue Filters the response to only return bulletins with specified value for IsDisruption.

Value can be true or false

No No

IsClearedValue Filters the response to only return bulletins with specified value for IsCleared.

Value can be true or false.

No No

P82571040 Issue 5a 23

HasContextValue Filters bulletins based in whether they have context or not.

Value can be true or false.

No No

Category Filters the response to only return bulletins with specified value for Category.

Value can be String like Fares, Disruption, Cancellation, Engineering works.

No No

Severity Filters the response to only return bulletins with the specified value for Severity.

Value can be String like High, Low, None.

No No

Mode Filters the response to only return bulletins with the specified value for Mode.

Value can be String like TRAIN, BUS, Ferry, Walk

No Yes

ServiceProviderName

Filters the response to only return bulletins with supplied ServiceProviderName.

Value can be any valid Service Provider Name.

No Yes

ServiceProviderCode

Filters the response to only returns bulletins with supplied ServiceProviderCode.

Value can be any valid Service Provider Code.

No Yes

Station Tiploc Returns bulletins for supplied tiploc station.

Value can be valid tiploc for station

No if crs has been mentioned

Yes

P82571040 Issue 5a 24

Train ID Filters the response to only return bulletins with the specified values for TrainId.

Value can be any valid train ID

No Yes

LineOfRoute Filters the response to only returns with the specified values for LineOfRoute.

Value can be String like District, Circle, Northern

No Yes

SpeakableText Filters the response to only return bulletins with the specified value for SpeakableText.

Value can be any valid text.

No No

11.3 Response Type

The data returned by this web service is based on data originally supplied by IPTIS.


11.4 Error Handling

Web Service checks validation on Station CRS and Station Tiplock. Invalid values of them can be return in response.


<soapenv:Envelopexmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/xmlns:dis="http://www.thalesgroup.com/ojp/dis">

<soapenv:Header/> <soapenv:Body> <dis:BulletinRequest> <dis:EffectiveAt>2014-05-01T02:00:00.000Z</dis:EffectiveAt> <dis:IsDisruptionValue>false</dis:IsDisruptionValue> <dis:IsClearedValue>false</dis:IsClearedValue> <dis:StationCRS>YMH</dis:StationCRS> <dis:StationTiploc>RYDP</dis:StationTiploc> </dis:BulletinRequest> </soapenv:Body></soapenv:Envelope>

P82571040 Issue 5a 25

http://schemas.xmlsoap.org/soap/envelope/

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:BulletinResponse

xmlns:ns2="http://www.thalesgroup.com/ojp/dis"xmlns:ns3="http://www.thalesgroup.com/ojp/commonBulletin">

<ns2:BulletinStatus> <ns3:Connectivity>Connected</ns3:Connectivity> <ns3:LastId>620520</ns3:LastId> <ns3:LastModifiedTime>2014-03-10T15:03:00.000Z</ns3:LastModifiedTime> </ns2:BulletinStatus> <ns2:BulletinList> <ns3:BulletinIsAlert="false"IsCleared="false"IsDisruption="false"> <ns3:Id>605005</ns3:Id> <ns3:Title>Groupsave is not valid on journeys</ns3:Title> <ns3:Description>to, from or on the Isle of Wight</ns3:Description> <ns3:Url/> <ns3:StartDateTime>2013-01-07T12:42:00.000Z</ns3:StartDateTime> <ns3:ExpiryDateTime>2014-12-31T02:00:00.000Z</ns3:ExpiryDateTime> <ns3:DisplayStartTime>00:00:00.000Z</ns3:DisplayStartTime> <ns3:DisplayEndTime>23:59:00.000Z</ns3:DisplayEndTime> <ns3:TargetUrlTarget="CallCentre"Url=""/> <ns3:TargetUrlTarget="Website"Url=""/> <ns3:StationAction="Pass"CRS="RYP"Name="Ryde Pier Head"Tiploc="RYDP"Type="Any"/> <ns3:StationAction="Pass"CRS="YMH"Name="Yarmouth (Isle Of Wight)"Tiploc="YMTHIOW"Type="Any"/> </ns3:Bulletin> </ns2:BulletinList> <ns2:BulletinRequestValidationErrors/> </ns2:BulletinResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

P82571040 Issue 5a 26

12. All Type of Disruption for station CRS (AllDisruptionInformation)

12.1 Overview

The AllDisruptionInformation function returns Station Messages, Bulletins, Disruptions and the National Service Indicator for the Station specified by its CRS code.

The information returned by this function combines the responses from the following functions

Bulletins

Station Message

DisruptionByStationCrs

National Service Indicator

12.2 Request Type




12.3 Response Type

The data returned by this Web Service is based on data originally supplied by NRE, IPTIS and Darwin. For NRE data web service constantly updates its records of current incidents based on this information.


12.4 Error Handling

Web service verifies supplied CRS are valid or not, and invalid station CRS can be return in response under invalid CRS section.



<soapenv:Header/> <soapenv:Body>P82571040 Issue 5a 27

<dis:AllDisruptionInformationRequest> <dis:stationCrs>BIT</dis:stationCrs> <dis:stationCrs>BI1</dis:stationCrs> </dis:AllDisruptionInformationRequest> </soapenv:Body></soapenv:Envelope>


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:AllDisruptionInformationResponse

xmlns:ns2="http://www.thalesgroup.com/ojp/dis"xmlns:ns3="http://www.thalesgroup.com/ojp/commonDisruption"xmlns:ns4="http://www.thalesgroup.com/ojp/commonBulletin"xmlns:ns5="http://www.thalesgroup.com/ojp/commonStationMessages">

<ns2:invalidCrsSupplied> <ns3:stationCRS>BI1</ns3:stationCRS> </ns2:invalidCrsSupplied> <ns2:allDisruptionsForCrs> <ns2:stationCRS>BIT</ns2:stationCRS> <ns2:stationBulletins> <ns2:BulletinStatus> <ns4:Connectivity>Connected</ns4:Connectivity> <ns4:LastId>620520</ns4:LastId> <ns4:LastModifiedTime>2014-03-10T15:03:00.000Z</ns4:LastModifiedTime> </ns2:BulletinStatus> <ns2:BulletinList/> </ns2:stationBulletins> <ns2:stationDisruptions> <ns3:disruption> <ns3:creationTime>2013-11-25T13:52:00.000Z</ns3:creationTime> <ns3:lastChangedDate>2014-02-19T15:26:00.000Z</ns3:lastChangedDate> <ns3:description><![CDATA[Chiltern Railways in partnership with Network Rail, are investing £130 million in building a new rail link between Oxford and London Marylebone.This will include:<ul><li>Laying almost a mile of new track between Bicester Town to just south of Bicester North to join the main line between Birmingham and London Marylebone <li>Renewal of existing track and signalling equipment <li>A new station between Oxford and Islip called Oxford Parkway </li></ul>From summer 2015 Chiltern Railways will introduce a new service between London Marylebone and Oxford Parkway.P82571040 Issue 5a 28

From spring 2016 these services will begin to run from the centre of Oxford. For further information please click <a href="http://www.chilternrailways.co.uk/bicester-oxford">here</a> or <a href="http://www.networkrail.co.uk/east-west-rail/?cd=1">here.</a>To allow this improvement work to take place the line between Oxford and Bicester Town will be closed until summer 2015, as a result buses will replace trains between Oxford and Bicester Town.Planning your JourneyFor full details of these changes and the impact on your journey, please use the National Rail Enquiries <a href="http://ojp.nationalrail.co.uk/">Journey Planner</a>]]></ns3:description> <ns3:equipmentReason>MAINTENANCE_WORK</ns3:equipmentReason> <ns3:incidentNumber>E85348624A0D432494443ADE6F479F26</ns3:incidentNumber> <ns3:participantRef>E85348624A0D432494443ADE6F479F26</ns3:participantRef> <ns3:planned>true</ns3:planned> <ns3:summary>Buses replace trains between Oxford and Bicester Town until Summer 2015</ns3:summary> <ns3:disruptionVersion>20140219152600</ns3:disruptionVersion>P82571040 Issue 5a 29

<ns3:changedBy>pthomas</ns3:changedBy> <ns3:ojpVersion>13</ns3:ojpVersion> <ns3:infoLinks> <ns3:label>nationalrail.co.uk</ns3:label> <ns3:uri>http://www.nationalrail.co.uk/service_disruptions/62816.aspx</ns3:uri> </ns3:infoLinks> <ns3:infoLinks> <ns3:label>Additional Maps</ns3:label> <ns3:uri>http://www.nationalrail.co.uk/static/documents/maps/Oxford_Bicester_Town(2).pdf</ns3:uri> </ns3:infoLinks> <ns3:networks> <ns3:affectedRoute>Trains between Oxford and Bicester Town</ns3:affectedRoute> </ns3:networks> <ns3:operators> <ns3:name>Chiltern Railways</ns3:name> <ns3:ref>CH</ns3:ref> </ns3:operators> <ns3:progress>open</ns3:progress> <ns3:validityPeriod> <ns3:startTime>2014-02-15T00:00:00.000Z</ns3:startTime> <ns3:endTime>2015-05-09T00:59:00.000+01:00</ns3:endTime> </ns3:validityPeriod> </ns3:disruption> </ns2:stationDisruptions> <ns2:stationMessages> <ns5:stationMessage> <ns5:stationCRS>BIT</ns5:stationCRS> <ns5:creationTime>2014-05-01T14:23:35.258+01:00</ns5:creationTime> <ns5:stationDistruption> <ns5:category>STATION</ns5:category> <ns5:severity>MINOR</ns5:severity> <ns5:xHtmlMessage>Because of engineering work, there are no train services at this station until Summer 2015. More details are available from the Current Engineering Work area of the <A href="http://nationalrail.co.uk/service_disruptions/62816.aspx">National Rail Enquiries website</A>.</ns5:xHtmlMessage> <ns5:description>E: Until Summer 2015</ns5:description> </ns5:stationDistruption> </ns5:stationMessage> </ns2:stationMessages> <ns2:serviceIndicator> <ns3:TocCode>CH</ns3:TocCode> <ns3:TocName>Chiltern Railways</ns3:TocName> <ns3:Status>Good service</ns3:Status> <ns3:StatusImage>icon-tick2.png</ns3:StatusImage> <ns3:TwitterAccount>NRE_Chiltern</ns3:TwitterAccount> <ns3:AdditionalInfo>Follow us on Twitter</ns3:AdditionalInfo> </ns2:serviceIndicator> </ns2:allDisruptionsForCrs> </ns2:AllDisruptionInformationResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

P82571040 Issue 5a 30

13. Service Indicator For TOC (ServiceIndicatorForToc)

13.1 Overview

The ServiceIndicatorForToc function returns the National Service Indicator data for the specified TOC.

13.2 Request Type

The following elements are supplied to the web service.


Toc Code Toc code for specific TOC Yes Yes

13.3 Response Type

The data that is returned by this web service has originally come from NRE and is updated every 5 minutes.

13.4 Error Handling

If the specified TOC is invalid then the response will have a list of invalid TOC codes. Invalid TOCs are held in the invalidTocCode attribute.

13.5 Request example


<soapenv:Header/> <soapenv:Body> <dis:ServiceIndicatorForTocRequest> <dis:tocCode>AW</dis:tocCode> <dis:tocCode>QW</dis:tocCode> </dis:ServiceIndicatorForTocRequest> </soapenv:Body></soapenv:Envelope>


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:ServiceIndicatorForTocResponse

xmlns:ns2=http://www.thalesgroup.com/ojp/disxmlns:ns3="http://www.thalesgroup.com/ojp/commonDisruption">

<ns2:serviceIndicator> <ns3:TocCode>AW</ns3:TocCode> <ns3:TocName>Arriva Trains Wales</ns3:TocName> <ns3:Status>Minor delays on some routes</ns3:Status>

P82571040 Issue 5a 31

http://www.thalesgroup.com/ojp/dis

<ns3:StatusImage>icon-note-noshadow.png</ns3:StatusImage> <ns3:ServiceGroup> <ns3:GroupName>Barmouth - Pwllheli</ns3:GroupName> <ns3:CurrentDisruption>32E1A96FAF524BA3B75FA8293E6E357F</ns3:CurrentDisruption> <ns3:CustomDetail>Read about this disruption</ns3:CustomDetail> <ns3:CustomURL>http://www.nationalrail.co.uk/</ns3:CustomURL> </ns3:ServiceGroup> <ns3:TwitterAccount>NRE_ArrivaWales</ns3:TwitterAccount> <ns3:AdditionalInfo>Latest travel news</ns3:AdditionalInfo> </ns2:serviceIndicator> <ns2:invalidTocCodes>QW</ns2:invalidTocCodes> </ns2:ServiceIndicatorForTocResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

P82571040 Issue 5a 32

14. Service Indicator For All TOCs (ServiceIndicatorForAllTocs)

14.1 Overview

The ServiceIndicatorForAllTocs function returns the National Service Indicator data for all TOCs.

14.2 Request Type

To retrieve all Nation Service Indicator information you need to make an empty request to this web service.

14.3 Response Type

The response type for this web service is a list of service indicators each holding their specific TOC service indicator information.



<soapenv:Header/> <soapenv:Body> <dis:ServiceIndicatorForAllTocsRequest/> </soapenv:Body></soapenv:Envelope>


Note : response shortened for brevity

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:ServiceIndicatorForAllTocsResponse

xmlns:ns2=http://www.thalesgroup.com/ojp/disxmlns:ns3="http://www.thalesgroup.com/ojp/commonDisruption">

<ns2:serviceIndicator> <ns3:TocCode>VT</ns3:TocCode> <ns3:TocName>Virgin Trains</ns3:TocName> <ns3:Status>Good service</ns3:Status> <ns3:StatusImage>icon-tick2.png</ns3:StatusImage> <ns3:TwitterAccount>NRE_Virgin</ns3:TwitterAccount> <ns3:AdditionalInfo>Follow us on Twitter</ns3:AdditionalInfo> </ns2:serviceIndicator> <ns2:serviceIndicator> <ns3:TocCode>GC</ns3:TocCode> <ns3:TocName>Grand Central</ns3:TocName> <ns3:Status>Good service</ns3:Status> <ns3:StatusImage>icon-tick2.png</ns3:StatusImage> <ns3:TwitterAccount>NRE_Grand_Centr</ns3:TwitterAccount> <ns3:AdditionalInfo>Follow us on Twitter</ns3:AdditionalInfo> </ns2:serviceIndicator> <ns2:serviceIndicator> <ns3:TocCode>LO</ns3:TocCode>

P82571040 Issue 5a 33

http://www.thalesgroup.com/ojp/dis

<ns3:TocName>London Overground</ns3:TocName> <ns3:Status>Good service</ns3:Status> <ns3:StatusImage>icon-tick2.png</ns3:StatusImage> <ns3:ServiceGroup> <ns3:GroupName>NorwoodJunction</ns3:GroupName> <ns3:CurrentDisruption>59075B0D1A6E4E1E8A172425B8ED1243</ns3:CurrentDisruption> <ns3:CustomDetail>Read about this disruption</ns3:CustomDetail> <ns3:CustomURL>http://www.nationalrail.co.uk/</ns3:CustomURL> </ns3:ServiceGroup> <ns3:TwitterAccount>NRE_LndnOvergnd</ns3:TwitterAccount> <ns3:AdditionalInfo>Follow us on Twitter</ns3:AdditionalInfo> </ns2:serviceIndicator>

<ns2:serviceIndicator> <ns3:TocCode>LE</ns3:TocCode> <ns3:TocName>Abellio Greater Anglia</ns3:TocName> <ns3:Status>Minor delays on some routes</ns3:Status> <ns3:StatusImage>icon-note-noshadow.png</ns3:StatusImage> <ns3:ServiceGroup> <ns3:GroupName>Colchester</ns3:GroupName> <ns3:CurrentDisruption>AFAF023416DC4B94AD558CE01F881780</ns3:CurrentDisruption> <ns3:CustomDetail>Read about this disruption</ns3:CustomDetail> <ns3:CustomURL>http://www.nationalrail.co.uk/</ns3:CustomURL> </ns3:ServiceGroup> <ns3:TwitterAccount>NRE_AbellioGA</ns3:TwitterAccount> <ns3:AdditionalInfo>Latest travel news</ns3:AdditionalInfo> </ns2:serviceIndicator> </ns2:ServiceIndicatorForAllTocsResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

P82571040 Issue 5a 34

Thales technical document - National · Web viewGetting Started Standards Compliance The API...

Documents

Transcript of Thales technical document - National · Web viewGetting Started Standards Compliance The API...