A train schedule is identified by a UID. Each UID may apply to several versions of a schedule, and each version may apply on different days - for example, if the train runs to a slightly different calling pattern on Saturdays and Sundays.
A version of a schedule can be uniquely identified by the schedule UID, start date and STP indicator field. If multiple schedules exist for a given date, the one with the lowest STP indicator is the valid one. This composite primary key is used when processing schedule updates to select the correct record to revise or delete.
The Short-Term Planning (STP) indicator for a particular schedule indicates the type of schedule:
|Permanent||P||WTT||A schedule which was generated by the Long-Term Planning process|
|Overlay||O||VAR||A variation to a schedule generated by the Long-Term Planning process|
|Short-Term Planned||N||STP||A schedule which was generated by the Short-Term Planning process. These are usually 'one-off' trains.|
|Cancellation||C||CAN||A planned cancellation which overlays the WTT schedule. This effectively says 'the schedule does not apply today', and are not an operational cancellation. See Planned Cancellations.|
NOTE: A CAN schedule will have no locations in the schedule, and exists to indicate that the train will not run on this date - it is a planned cancellation. This is a separate type of cancellation from an operational cancellation, where the train was planned to run, but was later cancelled.
A UID will refer to either:
- One or more WTT schedules and zero or more VAR or CAN schedules, or
- One or more STP schedules
It is not possible for a UID containing a WTT schedule to also contain an STP schedule.
Where more than one schedule appears to be valid for a particular date (for example, where a WTT schedule is overlaid by a VAR or CAN schedule), the schedule that is valid is the one which has the lowest alphabetic STP indicator.
Let's look at an example for UID A12345. There are two schedules:
- WTT schedule valid on Monday, Tuesday, Wednesday, Thursday and Friday from Monday 7th January 2013 to Friday 11th January 2013
- CAN schedule valid on Wednesday and Thursday from Wednesday 9th January 2013 to Thursday 10th January 2013
The result of overlaying these two schedules is that:
- The WTT schedule is valid on Monday 7th, Tuesday 8th and and Friday 11th January 2013
- The CAN schedule is valid on Wednesday 9th and Thursday 10th January 2013
If retrieving all the schedules for UID A12345 on Wednesday 9th January 2013, we'll see two schedules - the WTT schedule and the CAN schedule. Picking the schedule with the lower alphabetical STP indicator will select the CAN schedule, which is the schedule that applies on the day.
|Network Rail Open Data Feeds|
|Data Feeds||About the Feeds • Account States • Durable Subscriptions • Example Code ( PHP / C# / Java / Ruby / Node.js) • Advanced Uses • FAQ • Release Notes|
|Train Movements||Train Movements Feed • Train Activation • Train Cancellation • Train Movement • Train Reinstatement • Change of Origin • Change of Identity • TSPEED Field • Planned Cancellations • Cancellation Codes|
|TD||TD Feed • C-Class Messages • S-Class Messages • Train Describers • TD Berths|
|TSR||TSR Feed • Route Codes|
|SCHEDULE||SCHEDULE Feed • 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|