Revision as of 16:59, 6 March 2015

Train Alerts

Overview

Train alerts can be sent out through the Push Port by the NRCC or a TOC. A train alert can be attached to one or more services or to a station that the service calls at. The following table shows the data items in a train alert.

Data item	Description
Alert ID	Unique identifier for the alert
Services	List of services attached to this alert
SendAlertBySMS	If this is set to True, then this alert can be sent by SMS
SendAlertByEmail	If this is set to True, then this alert can be sent by Email
SendAlertByTwitter	If this is set to True, then this alert can be sent by Twitter
Source	The alert sender, either the TOC code or the string "NRCC"
AlertText	The text of the alert
Audience	The target audience of the alert, one of Customer, Staff, or Operations
AlertType	This can be either Normal or Forced. Forced alerts are sent by clients immediately, while Normal alerts are sent within a time window
CopiedFromAlertID	This is an optional item, and is the original Alert ID from which this alert has been copied
CopiedFromSource	This is an optional item, and is the original source (TOC code or "NRCC") from which this alert has been copied

@@ Line 1: / Line 1: @@
-The NRCC or a TOC can send important announcements (textual information known as train alerts) out via the Push Port. These alerts can be attached to various services and individual stations called at by those services. Prior to version 11 of the data schema these were known as “Ad-hoc alerts”.
+= Train Alerts =
-As a part of a Snapshot (Standard or Full), Darwin identifies train alerts and the services and stations to which they apply.
-As a part of an Update, Darwin provides new and revised versions of these alerts, as information becomes known to Darwin.
+== Overview ==
+Train alerts can be sent out through the Push Port by the NRCC or a TOC. A train alert can be attached to one or more services or to a station that the service calls at.
+The following table shows the data items in a train alert.
+{| class="wikitable"
+! Data item
+! Description
+|-
+|Alert ID
+|Unique identifier for the alert
+|-
+|Services
+|List of services attached to this alert
+|-
+|SendAlertBySMS
+|If this is set to True, then this alert can be sent by SMS
+|-
+|SendAlertByEmail
+|If this is set to True, then this alert can be sent by Email
+|-
+|SendAlertByTwitter
+|If this is set to True, then this alert can be sent by Twitter
+|-
+|Source
+|The alert sender, either the TOC code or the string "NRCC"
+|-
+|AlertText
+|The text of the alert
+|-
+|Audience
+|The target audience of the alert, one of Customer, Staff, or Operations
+|-
+|-
+|AlertType
+|This can be either Normal or Forced. Forced alerts are sent by clients immediately, while Normal alerts are sent within a time window
+|-
+|CopiedFromAlertID
+|This is an optional item, and is the original Alert ID from which this alert has been copied
+|-
+|CopiedFromSource
+|This is an optional item, and is the original source (TOC code or "NRCC") from which this alert has been copied
+|-
+|}