| Name |
Type |
Description |
| trainId |
String |
The train ID in the scheduling system |
| scheduleType |
String |
The schedule type of the schedule, valid values are
| WTT |
Working Timetable, this is usually the long term planning. |
| STP |
Short term planning schedules that does not include in the working timetable |
| OVL |
A modification of a working timetable that only applies on specified dates only |
| CAN |
The train does not run on the specified date |
|
| startDate |
Date |
Start date for this schedule in YYYY-MM-DD format |
| endDate |
Date |
End date for this schedule in YYYY-MM-DD format |
| daysRun |
String |
Indicate on which day will this train runs.
| M | Monday |
|---|
| Tu | Tuesday |
|---|
| W | Wednesday |
|---|
| Th | Thursday |
|---|
| F | Friday |
|---|
| S | Saturday |
|---|
| Su | Sunday |
|---|
| X | Except |
|---|
| O | Only |
|---|
e.g. SSuX means except Saturday and Sunday,
FO means Friday only.
|
| bankHolidayRun |
String |
Runs on bank holiday.
null | Runs on bank holiday |
|---|
| X | Does NOT runs on bank holiday |
|---|
| G | Does NOT runs on Glasgow bank holiday |
|---|
|
| endDate |
Date |
End date for this schedule in YYYY-MM-DD format |
| status |
String |
Train status code
| Permanent | STP | Description |
|---|
| B | 5 | Bus |
| F | 1 | Freight |
| P | 1 | Passenger and parcel |
| S | 4 | Ship |
| T | 3 | Trip |
|
| category |
String |
Train category |
| headcode |
String |
Headcode using to identify the train, also known as signal ID |
| reservationSystemHeadcode |
String |
Headcode for reservation system. The train operator code is included if there are reservation system headcode. |
| powerType |
String |
Power type of the train |
| timingLoad |
String |
Timing load of the train |
| speed |
int |
Planned speed of the train in miles per hour |
| operatingCharacters |
String |
Operating characteristics |
| classAvailable |
String |
Which class is available on this train
null | Both first and standard class is available |
|---|
| B | Both first and standard class is available |
|---|
| S | Only standard class is available |
|---|
|
| reservation |
String |
Reservation requirement for this train
| A | Reservations compulsory |
|---|
| E | Reservations for bicycles essential |
|---|
| R | Reservations recommended |
|---|
| S | Reservations possible from any station |
|---|
Note: Some train's reservation are counted space only, and no actual seat are assigned.
|
| catering |
String |
Catering availability on this train
|
| trainOperatorCode |
String |
ATOC code of the train operator operates this train |
| trainOperatorName |
String |
Name of the train operator operates this train |
| scheduleEntries |
TrainScheduleDetail[] |
Detail entries of the train schedule |