Post train announcements
Headers
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Destination of train. 3 letter CRS Location Code as <a href="https://docs.google.com/spreadsheets/d/1CkOeDjzdg5Gi_7n3UjOW5TduOHhjp47ge11rLNeQnVw/edit#gid=0">here</a>.Note: Can also receive TIPLOC codes, with TIPLOC Location Codes <a href="https://docs.google.com/spreadsheets/d/1CkOeDjzdg5Gi_7n3UjOW5TduOHhjp47ge11rLNeQnVw/edit#gid=0">here</a>.
If the train is going to a destination via another location. Comma separated Location Code (as above). Can be multiple destinations, with comma between codes.
Timing of train. 4 letter numerical string - HHMM. "" if no timing information
Platform of train. 0-24. Can combine with letters “A”,”B”,”C”&”D” e.g. “3A”. "" if no platform information
Updated timing of train if delayed. 4 letter numerical string - HHMM. "" if no updated timing information
Updated platform of train if platform changed. 0-24. Can combine with letters “A”,”B”,”C”&”D” e.g. “3A”. "" if no platform information
ATOC Code of UK Train Operating Companies, as found <a href="https://docs.google.com/spreadsheets/d/1I8_h2C5BFbUpxPth7aGIQv05PlRwOAinC1uhUQ6UW24/edit#gid=996621902">here.</a>
If train is cancelled
If train is indefinitely delayed
If train is indefinitely delayed, with an apologies
If there is a replacement bus service
Current station of train, that determines the correct bus stop message. 3 letter CRS Location Code with mapping as <a href="https://docs.google.com/spreadsheets/d/1I8_h2C5BFbUpxPth7aGIQv05PlRwOAinC1uhUQ6UW24/edit#gid=996621902">here.</a> Note: This requires “busReplacement”=”true”.
If no platform has yet been assigned
Comma separated Location Codes (as above), with unlimited locations in order. Note: The final location will always be signed, and does not need to be added as a variable. Note: Can accept TIPLOC codes as well as CRC codes.
If the train is not calling at any locations it usually does. Comma separated Location Codes (as above), with unlimited locations in order.
Adding a reason for a delay, cancellation or not calling at. Disruption codes follow the Darwin codes, with those available listed here.
Changing the message structure to be “next train from” (”next”), “The train now approaching” (”approaching”) or “The train now on” (”now”), as seen in the examples below.
Changing the message structure to be “This train will arrive” (”will_arrive”) or “This train has arrived” (”has_arrived”), as seen in the examples below.
Changing the message structure to be “The next stop is XXX” (”next”) or “The final stop is XXX” (”final”), as seen in the examples below.
Additional message for where the train splits at (”at”), where it splits for (”for”) and where the back/front of the train splits for (”back”/”front”). Note: Can be requested in any combination, added to the end of any requested video, or as stand-alone video.
If the train is currently at a given station or between two stations. Using CRS Location Codes (as above). If between two stations, pass 2 codes with comma between the codes. Note: Can be added to the end of any requested video, or as stand-alone video.
If the train is waiting here for XX minutes. Note: Can be added to the end of any requested video, or as stand-alone video.
If the platform is on the Left (”left”) or Right hand side (”right”) Exit on the Left hand side. Exit on the Right hand side. Note: Can be added to the end of any requested video, or as stand-alone video.
If there is a minor delay (”minor”), severe delay (”severe”) or special service (”special”) on a operator. Note: Must be paired with an “operator”. Can be paired with a Disruption Reason as above. Note: Can be added to the end of any requested video, or as stand-alone video.
Returns the lift status, with either numbers of broken and working lifts (e.g. 1broke,3work) or all working (allwork) or all broken (allbroke). Note: Will be returned as a stand-alone video.
Returns the escalator status, with either numbers of broken and working escalator (e.g. 1broke,3work) or all working (allwork) or all broken (allbroke). Note: Will be returned as a stand-alone video.
Change the background colour of the final video. Commas separate RGB colour value (e.g. “R,G,B”) NOTE: A transparent .webm video can be requested, by setting "bgColour":“-1,-1,-1” NOTE: A background colour not green (“18,195,83”) or Transparent (”1 ,-1,-1”) will take significantly longer to generate.