Darwin:Train Alert data: Difference between revisions

From Open Rail Data Wiki
Leo Inoue (talk | contribs)
37 edits
Created page with "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 indi..."
 
EvelynSnow (talk | contribs)
205 edits
Add train alert example
 
(3 intermediate revisions by 2 users not shown)
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.
 
== Detail==
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
|-
|}
 
== Examples (v16) ==
 
<pre><trainAlert>
  <ns8:AlertID>4079</ns8:AlertID>
  <ns8:AlertServices>
    <ns8:AlertService RID="202301167141954" UID="G41954" SSD="2023-01-16">
      <ns8:Location>VIC</ns8:Location>
      <ns8:Location>XVJ</ns8:Location>
      ...
      <ns8:Location>XUK</ns8:Location>
      <ns8:Location>DVP</ns8:Location>
    </ns8:AlertService>
  </ns8:AlertServices>
  <ns8:SendAlertBySMS>false</ns8:SendAlertBySMS>
  <ns8:SendAlertByEmail>false</ns8:SendAlertByEmail>
  <ns8:SendAlertByTwitter>false</ns8:SendAlertByTwitter>
  <ns8:Source>SE</ns8:Source>
  <ns8:AlertText>
This train is formed of 4 instead of 8 coaches today</ns8:AlertText>
  <ns8:Audience>Customer</ns8:Audience>
  <ns8:AlertType>Normal</ns8:AlertType>
</trainAlert></pre>
 
[[Category:National Rail Enquiries Data Feeds]]

Latest revision as of 21:16, 16 January 2023

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.

Detail

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

Examples (v16)

<trainAlert>
  <ns8:AlertID>4079</ns8:AlertID>
  <ns8:AlertServices>
    <ns8:AlertService RID="202301167141954" UID="G41954" SSD="2023-01-16">
      <ns8:Location>VIC</ns8:Location>
      <ns8:Location>XVJ</ns8:Location>
      ...
      <ns8:Location>XUK</ns8:Location>
      <ns8:Location>DVP</ns8:Location>
    </ns8:AlertService>
  </ns8:AlertServices>
  <ns8:SendAlertBySMS>false</ns8:SendAlertBySMS>
  <ns8:SendAlertByEmail>false</ns8:SendAlertByEmail>
  <ns8:SendAlertByTwitter>false</ns8:SendAlertByTwitter>
  <ns8:Source>SE</ns8:Source>
  <ns8:AlertText>
This train is formed of 4 instead of 8 coaches today</ns8:AlertText>
  <ns8:Audience>Customer</ns8:Audience>
  <ns8:AlertType>Normal</ns8:AlertType>
</trainAlert>
Retrieved from "https://wiki.openraildata.com/index.php?title=Darwin:Train_Alert_data&oldid=3067"