Train Cancellation

From Open Rail Data Wiki
Revision as of 04:02, 26 January 2013 by Tom Cairns (talk | contribs) (Document train cancellation messages)
Jump to navigation Jump to search

Overview

The Train Cancellation message is used to indicate a train that has been cancelled.

Example

{
    "header": {
        "msg_type": "0002",
        "source_dev_id": "L0BL",
        "user_id": "#QDP1120",
        "original_data_source": "TRUST DA",
        "msg_queue_timestamp": "1359167584000",
        "source_system_id": "TRUST"
    },
    "body": {
        "train_file_address": null,
        "train_service_code": "25437000",
        "orig_loc_stanox": "",
        "toc_id": "71",
        "dep_timestamp": "1359153300000",
        "division_code": "71",
        "loc_stanox": "80419",
        "canx_timestamp": "1359167580000",
        "canx_reason_code": "X2",
        "train_id": "802E51M725",
        "orig_loc_timestamp": "",
        "canx_type": "EN ROUTE"
    }
}

Data structure

Important Header fields

Field Description
msg_type Set to '0002' for a cancellation message
source_system_id Set to "TRUST" for cancellation messages
original_data_source Blank (for automatic cancellations on call), "SDR" (Simplified Direct Reporting) or "TRUST DA" (TRUST Delay Attribution)
user_id The identity of the user who made the cancellation

Body

It is important to note that TRUST is not able to cancel a train unless it has already reported at a location.

Field Description
train_file_address The TOPS train file address, if applicable
train_service_code Train service code as per schedule
orig_loc_stanox Only populated in cancellation type "OUT OF PLAN", and references the identity of the location that the schedule should have been at.
toc_id Operating company ID as per TOC_Codes
dep_timestamp Timestamp representing the departure time of the train at the location that the train is cancelled from
division_code As toc_id
loc_stanox The location that the schedule is being cancelled from. In "OUT OF PLAN" cancellations, this will not be in the schedule but a 0003 Train Movement message will have been sent.
canx_timestamp The time at which the cancellation is made in TRUST.
canx_reason_code Reason code for cancellation, as per the Delay Attribution Guide
train_id Set to the 10-character unique identity for this train, as appearing in other TRUST message types
orig_loc_timestamp Only populated in cancellation type "OUT OF PLAN", and references the departure time of the location that the schedule should have been at.
canx_type Populated with "ON CALL", "AT ORIGIN", "EN ROUTE" or "OUT OF PLAN".