Train Cancellation

A cancellation message is sent when the train does not, or will not, complete its scheduled journey.

A train may be cancelled in one of four ways:

• At activation time ("ON CALL"), usually where the applicable schedule has a STP indicator of "C" - see Planned Cancellations. Trains may be cancelled for other reasons before train has been activated, and when activation occurs, the train will be immediately cancelled with the appropriate reason code
• At the train's planned origin ("AT ORIGIN")
• En-route ("EN ROUTE")
• Off-route ("OUT OF PLAN")

As with all other messages, cancellation messages will only be received for train schedules which have already been activated.

Data structure

{
    "header": {
        "msg_type": "0002",
        "source_dev_id": "",
        "user_id": "",
        "original_data_source": "SDR",
        "msg_queue_timestamp": "1511528427000",
        "source_system_id": "TRUST"
    },
    "body": {
        "train_file_address": null,
        "train_service_code": "22721000",
        "orig_loc_stanox": "",
        "toc_id": "88",
        "dep_timestamp": "1511527680000",
        "division_code": "88",
        "loc_stanox": "87701",
        "canx_timestamp": "1511528400000",
        "canx_reason_code": "YI",
        "train_id": "871B26MK24",
        "orig_loc_timestamp": "",
        "canx_type": "EN ROUTE"
    }
}

Header

Field	Description
msg_type	Set to '0002' for a cancellation message
source_dev_id	Set to the device ID of the terminal that issued the request
user_id
source_system_id	Set to "TRUST" for a cancellation message
original_data_source	Set to "TOPS" or "SDR" for a reactionary cancellation, or "" for a planned cancellation (STP 'C')
msg_queue_timestamp

Body

Field	Description
train_file_address	The TOPS train file address, if applicable
train_service_code	Train service code as per the schedule
orig_loc_stanox	For an an "OUT OF PLAN" cancellation, this is the location that the train should have been at according to the schedule
toc_id	Operating company ID as per TOC Codes
dep_timestamp	The departure time at the location that the train is cancelled from (in milliseconds since the UNIX epoch)
division_code	Operating company ID as per TOC Codes
loc_stanox	The STANOX of the location that the train is being cancelled from. For an "OUT OF PLAN" cancellation, this STANOX will not be in the schedule, but a Train Movement message will have already been sent.
canx_timestamp	The time at which the cancellation was input to TRUST
canx_reason_code	The reason code for the cancellation, taken from the Delay Attribution Guide
train_id	The 10-character unique identity for this train (sent in the TRUST activation message)
orig_loc_timestamp	For an "OUT OF PLAN" cancellation, this is the departure time of the location that the train should have been at according to the schedule
canx_type	Either "ON CALL" for a planned cancellation, "AT ORIGIN", "EN ROUTE" or "OUT OF PLAN"