TSR: Difference between revisions

From Open Rail Data Wiki
Add TSR documentation
 
m →‎Detail: Update groups in TSR feed
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Overview ==
Temporary Speed Restriction (TSR) messages are sent once a week, on a Friday at 0600, and contain a snapshot of the TSRs published in the [http://www.safety.networkrail.co.uk/Services/Jargon-Buster/W/WK-WO/WON Weekly Operating Notice].


Temporary Speed Restriction (TSR) messages are sent once a week, on a Friday at 0600, and contain a snapshot of the TSRs published in the [http://www.safety.networkrail.co.uk/Services/Jargon-Buster/W/WK-WO/WON Weekly Operating Notice].
If your client is not connected at 0600 on a Friday, or does not have a durable subscription in place at this time, you will not receive the TSR messages.


== Topics ==
= Topics =


TSR data is available in an all-route feed, as well as specific localised feedsTopic names are as follows:
TSR data is available on a single topic, TSR_ALL_ROUTEPreviously, the messages were split in a number of topics, listed below for historical purposes only:


{| class="wikitable"
{| class="wikitable"
!Topic
!Historical topic
!Description
!Description
|-
|-
Line 49: Line 49:
|}
|}


== Detail ==
= Detail =


One TSRBatchMsg is sent for each route group, containing the TSRs in that route group.  The groups are:
One TSRBatchMsg is sent for each route group, containing the TSRs for that group.  Route groups are identified by the routeGroupCode, however these are liable to change without notice in the future as the groups are revised. 


* Scotland
The groups are:
* London North Western (South)
 
* East Midlands
{| class="wikitable"
* Anglia
!Description
* Western
|-
* London North Eastern (South)
|Scotland
* London North Eastern (Central)
|-
* London North Eastern (North)
|London North Western (South)
* London North Western (North)
|-
* Kent & Sussex
|East Midlands
* Wessex
|-
|Anglia
|-
|Western and Wales
|-
|London North Western (North)
|-
|Kent & Sussex
|-
|Wessex
|-
|London North Eastern
|-
|}
 
Individual routes that TSRs apply to are represented by [[RouteCode|Route Codes]].
 
= Data Structure =
 
<pre>
{
    "TSRBatchMsgV1": {
        "schemaLocation": "http://xml.hiav.networkrail.co.uk/schema/net/tsr/1 net_tsr_messaging_v1.xsd",
        "owner": "Network Rail",
        "timestamp": "1422868697000",
        "originMsgId": "2015-02-02T09:18:23.718+00:00-9PPS",
        "classification": "industry",
        "systemEnvironmentCode": "Production",
        "Sender": {
            "organisation": "Network Rail",
            "application": "HUB",
            "applicationDomain": "net",
            "instance": "",
            "component": "",
            "userID": "",
            "sessionID": "",
            "conversationID": "",
            "messageID": ""
        },
        "Publication": {
            "TopicID": "TSR/9"
        },
        "TSRBatchMsg": {
            "routeGroup": "Wessex",
            "routeGroupCode": "9",
            "publishDate": "1422597602000",
            "publishSource": "WON_1415_46_F",
            "routeGroupCoverage": "full",
            "batchPublishEvent": "publishWON",
            "WONStartDate": "1423267260000",
            "WONEndDate": "1423871940000",
            "tsr": [
                {
                    "TSRID": "105556",
                    "creationDate": "1390985378000",
                    "publishDate": "1422597602000",
                    "publishEvent": "nonSpecific",
                    "RouteGroupName": "Wessex",
                    "RouteCode": "SW105",
                    "RouteOrder": "701",
                    "TSRReference": "T2013/105556",
                    "FromLocation": "Wool",
                    "ToLocation": "Wool",
                    "LineName": "Up",
                    "SubunitType": "chains",
                    "MileageFrom": "126",
                    "SubunitFrom": "26",
                    "MileageTo": "123",
                    "SubunitTo": "45",
                    "MovingMileage": "false",
                    "PassengerSpeed": "50",
                    "FreightSpeed": "50",
                    "ValidFromDate": "1392026400000",
                    "ValidToDate": "64060675199000",
                    "Reason": "Condition Of Track",
                    "Requestor": "Network Rail Wessex (Eastleigh MDUM)",
                    "Comments": null,
                    "Direction": "up"
                },
               
                ...
               
            ]
        }
    }
}
</pre>
 
== Fields ==
 
{| class="wikitable"
!Field
!Description
|-
|routeGroup
|The name of the route group
|-
|routeGroupCode
|Numeric code of the route group.
|-
|publishDate
|The date Weekly Operating Notice was published.
|-
|publishSource
|Identifier of Weekly Operating Notice.
|-
|WONStartDate
|Start of the Weekly Operating Notice period.
|-
|WONEndDate
|End of the Weekly Operating Notice period.
|-
|}


For each TSR, the following keys are present:
For each TSR, the following keys are present:
Line 70: Line 182:
!Field
!Field
!Description
!Description
|-
|TSRID
|Identifier of TSR
|-
|creationDate
|The date TSR was originally created
|-
|publishDate
|
|-
|publishEvent
|
|-
|-
|RouteGroupName
|RouteGroupName
Line 84: Line 208:
|-
|-
|FromLocation
|FromLocation
|The location at which the TSR begins
|Full name of the location at which the TSR begins
|-
|-
|ToLocation
|ToLocation
|The location at which the TSR ends
|Full name of the location at which the TSR ends
|-
|-
|LineName
|LineName
Line 117: Line 241:
|-
|-
|WONValidFrom
|WONValidFrom
|Start date of the TSR, formatted according to WON dates
|Start date of the TSR, formatted according to WON dates (optional key)
|-
|-
|WONValidTo
|WONValidTo
|End date of the TSR, formatted according to WON dates
|End date of the TSR, formatted according to WON dates (optional key)
|-
|-
|Reason
|Reason
Line 132: Line 256:
|-
|-
|Direction
|Direction
|The line direction to which the TSR is applicable
|The line direction (up / down) to which the TSR is applicable
|-
|-
|}
|}
{{Navtable-DataFeeds}}
[[Category:TSR Data]]

Latest revision as of 10:35, 6 December 2023

Temporary Speed Restriction (TSR) messages are sent once a week, on a Friday at 0600, and contain a snapshot of the TSRs published in the Weekly Operating Notice.

If your client is not connected at 0600 on a Friday, or does not have a durable subscription in place at this time, you will not receive the TSR messages.

Topics

TSR data is available on a single topic, TSR_ALL_ROUTE. Previously, the messages were split in a number of topics, listed below for historical purposes only:

Historical topic Description
TSR_ALL_ROUTE All routes
TSR_ANG_ROUTE Anglia route
TSR_WEST_ROUTE Western route
TSR_KENT_SUSS_ROUTE Kent & Sussex route
TSR_WESS_ROUTE Wessex route
TSR_SCOT_ROUTE Scotland route
TSR_LNE_S_ROUTE London North Eastern (South) Route
TSR_LNE_C_ROUTE London North Eastern (Central) Route
TSR_LNE_N_ROUTE London North Eastern (North) Route
TSR_LNW_S_ROUTE London North Western (South) Route
TSR_LNW_N_ROUTE London North Western (North) Route
TSR_EM_ROUTE East Midlands route

Detail

One TSRBatchMsg is sent for each route group, containing the TSRs for that group. Route groups are identified by the routeGroupCode, however these are liable to change without notice in the future as the groups are revised.

The groups are:

Description
Scotland
London North Western (South)
East Midlands
Anglia
Western and Wales
London North Western (North)
Kent & Sussex
Wessex
London North Eastern

Individual routes that TSRs apply to are represented by Route Codes.

Data Structure

{
    "TSRBatchMsgV1": {
        "schemaLocation": "http://xml.hiav.networkrail.co.uk/schema/net/tsr/1 net_tsr_messaging_v1.xsd",
        "owner": "Network Rail",
        "timestamp": "1422868697000",
        "originMsgId": "2015-02-02T09:18:23.718+00:00-9PPS",
        "classification": "industry",
        "systemEnvironmentCode": "Production",
        "Sender": {
            "organisation": "Network Rail",
            "application": "HUB",
            "applicationDomain": "net",
            "instance": "",
            "component": "",
            "userID": "",
            "sessionID": "",
            "conversationID": "",
            "messageID": ""
        },
        "Publication": {
            "TopicID": "TSR/9"
        },
        "TSRBatchMsg": {
            "routeGroup": "Wessex",
            "routeGroupCode": "9",
            "publishDate": "1422597602000",
            "publishSource": "WON_1415_46_F",
            "routeGroupCoverage": "full",
            "batchPublishEvent": "publishWON",
            "WONStartDate": "1423267260000",
            "WONEndDate": "1423871940000",
            "tsr": [
                {
                    "TSRID": "105556",
                    "creationDate": "1390985378000",
                    "publishDate": "1422597602000",
                    "publishEvent": "nonSpecific",
                    "RouteGroupName": "Wessex",
                    "RouteCode": "SW105",
                    "RouteOrder": "701",
                    "TSRReference": "T2013/105556",
                    "FromLocation": "Wool",
                    "ToLocation": "Wool",
                    "LineName": "Up",
                    "SubunitType": "chains",
                    "MileageFrom": "126",
                    "SubunitFrom": "26",
                    "MileageTo": "123",
                    "SubunitTo": "45",
                    "MovingMileage": "false",
                    "PassengerSpeed": "50",
                    "FreightSpeed": "50",
                    "ValidFromDate": "1392026400000",
                    "ValidToDate": "64060675199000",
                    "Reason": "Condition Of Track",
                    "Requestor": "Network Rail Wessex (Eastleigh MDUM)",
                    "Comments": null,
                    "Direction": "up"
                },
                
                ...
                
            ]
        }
    }
}

Fields

Field Description
routeGroup The name of the route group
routeGroupCode Numeric code of the route group.
publishDate The date Weekly Operating Notice was published.
publishSource Identifier of Weekly Operating Notice.
WONStartDate Start of the Weekly Operating Notice period.
WONEndDate End of the Weekly Operating Notice period.

For each TSR, the following keys are present:

Field Description
TSRID Identifier of TSR
creationDate The date TSR was originally created
publishDate
publishEvent
RouteGroupName The name of the route group
RouteCode The RouteCode on which the TSR exists
RouteOrder
TSRReference The reference of this TSR
FromLocation Full name of the location at which the TSR begins
ToLocation Full name of the location at which the TSR ends
LineName The name of the line to which the TSR applies
SubUnitType The sub-unit type, i.e. "yards" or "chains"
MileageFrom/SubunitFrom The mileage and sub-unit (yards or chains) of the start of the TSR on this line
MileageTo/SubunitTo The mileage and sub-unit (yards or chains) of the end of the TSR on this line
MovingMileage Set to "true" if the TSR may be moved progressively along the line
PassengerSpeed The maximum permitted speed for a passenger train through the TSR
FreightSpeed The maximum permitted speed for a freight train through the TSR
ValidFromDate Start date of the TSR
ValidToDate End date of the TSR
WONValidFrom Start date of the TSR, formatted according to WON dates (optional key)
WONValidTo End date of the TSR, formatted according to WON dates (optional key)
Reason The reason for the TSR
Reqestor The name of the requesting party
Comments Comments associated with the TSR
Direction The line direction (up / down) to which the TSR is applicable


Network Rail Open Data Feeds
Data Feeds About the Feeds Account States Durable Subscriptions Example Code ( PHP / C# / Java / Ruby / Node.js) • Advanced UsesFAQ Release Notes
RTPPM RTPPM Feed
Train Movements Train Movements Feed Train Activation Train Cancellation Train Movement Train Reinstatement Change of Origin Change of Identity Change of Location TSPEED Field Planned Cancellations Cancellation Codes
TD TD Feed C-Class Messages S-Class Messages Train Describers TD Berths
VSTP VSTP Feed
TSR TSR Feed Route Codes
SCHEDULE SCHEDULE Feed TIPLOC Records Schedule and Location Records Association Records CIF Codes How Scheduling Works Allowances
Reference Data Reference Data Feed TOC Codes CIF Codes Delay Attribution Codes Identifying Locations (STANOX, TIPLOC, NLC and 3-Alpha Codes) STANOX Geographical Areas Train Planning data (BPLAN)