Alert Payload Samples

Welcome to the alert type payload samples for the Traveler Trip Alert and Agent Alert Services. Here you can browse each alert type to learn more about its purpose, interpret details and to view an actual payload response.

These examples can be used as a starting point to help you during your evaluation of our Services or when developing technology to consume our Services.

General Notes:
  • All Alerts will contain the id string field at the top level of the alert which is used internally at Cirium to uniquely identify the alert.
  • Arrival and departure times located within the flightStatuses reference local airport time.
  • Cirium aggregates data from many sources to provide the industry’s most complete global coverage of commercial airline flight information. We use that data and our expertise in the flight domain to derive estimated arrival times, departure times and connection times.
  • Flight data in Cirium Trip alerts include ‘FS’ and ‘IATA’ airline and airport codes. ‘FS’ codes are unique proprietary airline and airport identifiers that have been deprecated in the Cirium system. Cirium Trip alerts also include generically labeled attributes appended with just ‘airlineCode’ and ‘airportCode’, and they have also been deprecated. If your system uses IATA codes and is not reliant on FS codes (most cases), it is recommended that you apply the attributes appended with ‘IataCode’. If you are currently using attributes appended with just ‘airlineCode’ and ‘airportCode’ you can continue to use them. In most cases they will represent applicable IATA codes.
ACTUAL CONNECTION PROBLEM

The Actual Connection Problem alert type is used to inform agencies about connection problems that have actually occurred between flights in their trip. Unlike the Estimated Connection Problem alert, this alert is not used as an alert to notify passengers because it is triggered after the departing flight in a connection has departed.

This alert is based on actual gate departures, actual gate arrivals, and the Minimum Connect Time (MCT) published by the airline.

This alert is sent if the connection time for any connection on the trip falls below a level that indicates the connection would have been at risk. Only one Actual Connection Problem alert is sent for any given at-risk connection.


The connection in this sample is at risk. The trip has one leg with three flights.
Under the alertDetails attribute, you can see:
  • type is Actual Connection Problem.
  • The alert is for the connection of the second and third flight in the leg.
    legIndex is 0
    inboundFlightIndex is 1
    outboundFlightIndex is 2
  • The dateTime attribute shows that the alert was sent at 2019-11-20T18:05:06.616893Z.
  • The connectionTime (current) is -63 minutes.
  • The minimumConnectTime is 45. Minimum Connect Time (MCT) is a value published by the airline representing the minimum recommended connect time for booked connections.
Under the flightStatuses attribute for the connecting flights you can see:
  • The second flight actually arrived at 2019-11-20T13:00:00.
  • The third flight actually departed at "2019-11-20T11:57:00.
Actual Connection Problem alert (click to display)

        
CONNECTION INFO
The Connection Info alert type is used to inform the traveler about connections between flights in their trip.

There are different events that would result in this alert being triggered:
  1. An initial status alert is sent a set number of minutes before the scheduled gate arrival of the incoming flight. This occurs for each connection in the trip. The amount of time that an alert is sent before the scheduled gate departure can be configured through your Cirium account representative.
  2. Update alerts are sent each time the estimated connection time from the previous alert is changed by more than a configured number of minutes. The configured number of minutes can be set through your Cirium account representative. These alerts are only triggered after the initial status alert is sent.

Note: This alert type does not include Gate Change updates. The CONNECTION INFORMATION GATE CHANGE alert is complementary to this alert. If Connection Info alerts are enabled, Connection Information Gate Change alerts will also be sent when triggered.


This initial status alert is scheduled, and may serve as a passenger reminder and an alert. It contains current connection time and gate information.

In this sample, the flight has two legs, with one flights in the first leg and two flights in the second leg. This alert sample is associated with the connecting flights in the second leg. It was configured to be sent 60 minutes before the scheduled gate arrival of the connecting flight. It was set to 60 minutes through a Cirium account representative..

Under the alertDetails attribute, you can see:
  • type is Connection Info.
  • The connection referenced in this alert is between the first and second flight in the second leg.
    legIndex is 1
    inboundFlightIndex is 0
    outboundFlightIndex is 1
  • The dateTime attribute shows that the alert was sent at 2019-11-20T14:28:08.925408Z.
  • The connectionTime (current) is 38 minutes, indicating that there is sufficient time between the estimated arrival of the inbound flight and the estimated departure of the outbound flight.
  • The minimumConnectTime is 30 minutes. Minimum Connect Time (MCT) is a value published by the airline representing the minimum recommended connect time for booked connections.

Note: We use our expertise in the flight domain to derive the connection time based on actual, runway, estimated and scheduled arrival and departure times.

Under the flightStatuses attribute for the connecting flights you can see:
  • The first flight of the second leg is scheduled to arrive in CVG at 2019-11-20T10:28:00 (UTC-5) and this scheduled alert was triggered exactly one hour before the flight was scheduled to arrive.
  • The estimated arrival time for the arriving flight in the connection is 2019-11-20T10:17:00. The scheduled departure time for the departing flight in the connection is 2019-11-20T10:55:00 Scheduled departure time may be applied for calculating connectionTime if an estimated departure time is unavailable.
Connection Info alert (click to display)

        


The following is a sample of a sent update alert. The connection referenced in this alert sample is between the first and second flight in the second leg. The initial status alert had already been sent (see the previous example).

In this case, an updated Connection Info alert was triggered because the estimated connection time changed 20 minutes from the previous alert by more than a a configured threshold (e.g. delta trigger set to 10 minutes). This delta for number of minutes can be configured through your Cirium account representative.

Under the alertDetails attribute, you can see:
  • In this sample, the flight has two legs, with one flight in the first leg and two flights in the second leg. This alert sample is associated with the connecting flights in the second leg.
    legIndex is 1
    inboundFlightIndex is 0
    outboundFlightIndex is 1
  • The dateTime attribute shows that the alert was sent at 2019-11-20T14:58:12.864852Z.
  • The connectionTime includes a current and previous time.
    In this case, the connection time is 20 minutes less than it was with the previous alert. It was previously 38 and currently it is 18. Note that in this case while the connection time is still a positive number of minutes, it is now less than the minimumConnectTime, which is 30 minutes. That indicates that the outbound flight connection may be at risk.
Under the flightStatuses attribute for the connecting flights you can see:
  • The first flight is estimated to arrive at 2019-11-20T10:37:00.
  • The second flight is scheduled to depart at 2019-11-20T10:55:00.
Updated Connection Info alert (click to display)

        
CONNECTION INFO GATE CHANGE

The Connection Info Gate Change alert type is used to inform the traveler about gate information for the outgoing (departing) flights for all connections in a trip.

These alerts are complementary to the Connection Info alerts. If you are set to receive Connection Info alerts, you will also receive Connection Info Gate Change alerts when appropriate.

Gate change events that are registered more than 1 hour before a flight is scheduled to depart are buffered for 5 minutes before alerts are triggered. Within an hour of the scheduled departure, they are sent immediately.


Under the alertDetails attribute, you can see:
  • type is Connection Info Gate Change.
  • In this sample, the flight has two legs, with one flight in the first leg and two flights in the second leg. This alert sample is associated with the connecting flights in the second leg.
    legIndex is 1
    inboundFlightIndex is 0
    outboundFlightIndex is 1
    The gate change alert occurs for gate changes in the outgoing flight in the connection (in this case, the departure gate for the second flight in the leg).
  • The dateTime attribute shows that the alert was sent at 2019-11-20T15:03:21.873561Z.
  • gate (current) is B21 and gate (previous) is B19, so the gate had just changed from B19 to B21
Connection Info Gate Change alert (click to display)

        
ESTIMATED CONNECTION PROBLEM

The Estimated Connection Problem alert type is used to inform the traveler about connection problems between flights in their trip.

An alert is sent if the connection time for any connection on a trip falls below a level that indicates the connection is at risk. Cirium uses collected data about the connecting flights with the Minimum Connect Time published by the airline to determine the level at which a connection is at sufficient risk for notifying passengers.

Only one Estimated Connection Problem alert is sent for any given at-risk connection in a trip.


The connection in this example is at risk. The flight has one leg with four flights.
Under the alertDetails attribute, you can see:
  • type is Estimated Connection Problem.
  • legIndex is 0
  • inboundFlightIndex is 2 and outboundFlightIndex is 3.
    The alert is for the connection of the third and fourth flight in the leg.
  • dateTime shows that the alert was sent at 2019-11-26T02:04:31.419246Z.
  • connectionTime (current) is 15 minutes.
  • minimumConnectTime is 60. Minimum Connect Time (MCT) is a value published by the airline representing the minimum recommended connect time for booked connections.
Under the flightStatuses attribute for the connecting flights you can see:
  • The inbound connecting flight is estimated to arrive at Lisbon airport at 2019-11-26T13:40:00 (local time in Lisbon).
  • The scheduled departure time for the departing flight in the connection at Lisbon is 2019-11-26T13:55:00.
Estimated Connection Problem alert (click to display)

        
FLIGHT ARRIVAL DELAY

The Flight Arrival Delay alert type is used to inform the traveler about arrival delays for every flight in a trip.

  1. An initial update alert is sent if the gate arrival of a flight is estimated to be delayed beyond a set number of minutes. The amount of time that a flight must be delayed before this alert is sent can be configured through your Cirium account representative.
  2. Update alerts are sent each time the arrival time for a flight is delayed a set number of minutes beyond the delay that triggered the previous alert. The amount or threshold of time that a flight must be delayed before this alert is sent can also be configured through your Cirium account representative.

Under the alertDetails attribute, you can see:
  • type is Flight Arrival Delay.
  • legIndex is 1 and flightIndex is 0. The alert is for the first flight in the second leg.
  • dateTime shows that the alert was sent at 2019-11-26T16:16:56.044228Z.
  • delay (current) is 105 minutes and delay (previous) is 75 minutes. This means that an was previously triggered when it was delayed by 75 min. The estimated delay was extended another 30 minutes, and this alert was triggered.
  • The scheduledGateDateTime for the flight's arrival is 2019-11-26T16:45:00.
  • The estimatedGateDateTime for the flight is 2019-11-26T18:30:00.
Flight Arrival Delay alert (click to display)

        
FLIGHT ARRIVAL GATE CHANGE

The Flight Arrival Gate Change alert type is used to inform the traveler about gate changes for every arriving flight in a trip.

These alerts start getting sent a set number of minutes before the flight is scheduled to arrive at the gate. The number of minutes before scheduled arrival can be configured through your Cirium account representative.

An alert is sent for each gate change up until the flight actually arrives.


Under the alertDetails attribute, you can see:
  • type is Flight Arrival Gate Change.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight of the trip.
  • dateTime shows that the alert was sent at 2019-11-26T18:58:25.553224Z.
  • gate (current) is 50 and gate (previous) is 49. This means that this alert was previously triggered for this flight when the arrival gate was changed to 49 and triggered again when it changed to 50.
Flight Arrival Gate Change alert (click to display)

        
FLIGHT ARRIVAL UPDATE

This alert type informs the recipient about the arrival of all flights in a trip. It sends a scheduled status alert a configured number of minutes before the scheduled gate arrival of each flight. Information in this alert includes Leg Index, Flight Index, and Minutes Before Arrival.

Flight Arrival Update alert (click to display)

        
FLIGHT ARRIVED

The Flight Arrived alert type notifies the recipient when each flight in a trip has actually landed or arrived at the gate.


This sample sent alert is for a trip that has one leg with four flights.

Under the alertDetails attribute, you can see:
  • type is Flight Arrived.
  • legIndex is 0 and flightIndex is 1. The alert is for the second flight of the only leg in the trip.
  • dateTime shows that the alert was sent at 2019-11-20T05:34:29.603525Z.
Flight Arrived alert (click to display)

        
FLIGHT ARRIVED LATE

The Flight Arrived Late alert type is used to identify flights that are confirmed to have actually arrived late at the gate.

A single alert is sent once the system identifies the final actual arrival time of a flight, but only if that final time is later than a set number of minutes after the scheduled gate arrival time. That number minutes can be configured through your Cirium account representative.


Under the alertDetails attribute, you can see:
  • type is Flight Arrived Late.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight of the trip.
  • dateTime shows that the alert was sent at 2019-11-26T17:20:29.834174Z.
  • minutesLate is 65.
Flight Arrived Late alert (click to display)

        
FLIGHT BAGGAGE CHANGE

The Flight Baggage Change alert type is used to inform the traveler about baggage claim changes that occur for an arriving flight.
Alerts are sent each time the baggage claim information changes.

These alerts start getting sent a set number of minutes before the flight is scheduled to arrive at the gate. The number of minutes before scheduled arrival can be configured through your Cirium account representative.

An alert is sent for each baggage terminal change.


Under the alertDetails attribute, you can see:
  • type is Flight Baggage Change.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight of the trip.
  • dateTime shows that the alert was sent at 2019-11-26T06:30:13.070197Z.
  • baggage (current) is 3 and baggage (previous) is 2. This means that this alert was previously triggered for this flight when baggage terminal was 2, and this alert was triggered when it changed to 3.
Flight Baggage Change alert (click to display)

        
FLIGHT CANCELLED & REINSTATED

The Flight Cancellation and Flight Reinstated alert types are used to inform the traveler if any flight on a trip is reported as cancelled and then if a cancelled flight is reinstated.


This sample alert is for a trip with a cancelled flight. Note that the cancelled flight is the fourth flight in a one leg trip. status under flightStatuses now reads as Cancelled.

Note: the second sample is for the same flight being reinstated

Flight Cancellation alert (click to display)

        

This sample alert is for a trip with a previously cancelled flight that was reinstated. The cancelled flight was the fourth flight in a one leg trip. status under flightStatuses now reads as Scheduled after being reinstated.

Flight Reinstated alert (click to display)

        
FLIGHT DEPARTED

The Flight Departed alert type notifies the recipient when each flight in a trip has actually departed from the gate or the runway.


This sample sent alert is for a trip with one leg and two flights.

Under the alertDetails attribute, you can see:
  • type is Flight Departed.
  • legIndex is 1 and flightIndex is 0. The alert is for the first flight in the second leg.
  • dateTime shows that the alert was sent at 2019-11-20T14:04:25.627521Z.
Flight Departed alert (click to display)

        
FLIGHT DEPARTED LATE

The Flight Departed Late alert type is used to identify flights that are confirmed to have actually departed late from the gate.

A single alert is sent once the system identifies the final actual departure time of a flight, but only if that final time is later than a set number of minutes after the scheduled gate departure time. That number of minutes can be configured through your Cirium account representative.


Under the alertDetails attribute, you can see:
  • type is Flight Departed Late.
  • legIndex is 0 and flightIndex is 1. The alert is for the second flight of the trip.
  • dateTime shows that the alert was sent at 2019-11-20T14:33:22.722688Z.
  • minutesLate is 18.
Flight Departed Late alert (click to display)

        
FLIGHT DEPARTURE DELAY

The Flight Departure Delay alert type is used to inform the traveler about departure delays for every flight a trip.

  1. An initial update alert is sent if the departure of a flight is estimated to be delayed beyond a set number of minutes. The amount of time that a flight must be delayed before this alert is sent can be configured through your Cirium account representative.
  2. Update alerts are sent each time the departure time for a flight is delayed a set number of minutes beyond the delay that triggered the previous alert. The amount of time that a flight must be delayed before this alert is sent can also be configured through your Cirium account representative.

Under the alertDetails attribute, you can see:
  • type is Flight Departure Delay.
  • legIndex is 0 and flightIndex is 2. The alert is for the third flight in the first leg.
  • dateTime shows that the alert was sent at 2019-11-26T08:10:13.319091Z.
  • delay (current) is 40 minutes. There was no previous delay. The flight was delayed 40 minutes when the alert was triggered.
  • The scheduledGateDateTime for the flight's departure is 2019-11-26T10:50:00.
  • The estimatedGateDateTime for the flight's departure is 2019-11-26T11:30:00.
Flight Departure Delay alert (click to display)

        
FLIGHT DEPARTURE GATE CHANGE

The Flight Departure Gate Change alert type is used to inform the traveler about departure gate changes for every flight in a trip.

These alerts start getting sent a set number of minutes before the flight is scheduled to depart from the gate. The number of minutes before scheduled departure can be configured through your Cirium account representative.

An alert is sent for each gate change up until the time the flight actually departs.


Under the alertDetails attribute, you can see:
  • type is Flight Departure Gate Change.
  • legIndex is 0 and flightIndex is 2. The alert is for the third flight of the first leg of the trip.
  • dateTime shows that the alert was sent at 2019-11-20T13:40:32.463563Z.
  • gate "current" is B19 and gate "previous" is B18. This means the alert was triggered when the gate was updated to B19. If there is no 'previous' gate attribute, it means that there the gate information was not published prior to the Flight Departure Gate Change alert.
Flight Departure Gate Change alert (click to display)

        
FLIGHT DEPARTURE UPDATE

The Flight Departure Update alert type is used to inform the traveler about the departure of every flight in a trip.

A single update alert will be sent a set number of minutes before each flight is scheduled to depart. The set number of minutes can be configured through your Cirium account representative.


Under the alertDetails attribute, you can see:
  • type is Flight Departure Update.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight of the trip.
  • dateTime shows that the alert was sent at 2019-12-05T21:44:14.578029Z.
  • minutesBeforeDeparture is 60. In this sample, the alert was set to be sent 60 minutes before each scheduled flight departure time.
Flight Departure Update alert (click to display)

        
FLIGHT DIVERSION

The Flight Diversion alert type is used to inform the recipient if any flight on the trip lands at an airport that it was not scheduled to arrive at.


In this sample alert, a flight that was scheduled to land at Boston Logan Airport (BOS) was diverted to Dallas/Fort Worth Airport (DFW).

Note: Carriers do not always include the airport that flights are diverted to when they report that a flight was diverted. Because of that, the "diverted" airport may not always be included in the Flight Diversion alert.

Under the alertDetails attribute, you can see:
  • type is Flight Diversion.
  • legIndex is 0 and flightIndex is 1. The alert is for the second flight of the first leg of the trip.
  • dateTime shows that the alert was sent at 2019-12-04T01:35:06.435Z.
Under the flightStatuses attribute, you can see:
  • diverted is "airportCode": "DFW".
Flight Diversion alert (click to display)

        
LEG ARRIVAL DELAY

The Leg Arrival Delay alert type notifies the recipient if the gate arrival of the last flight of a leg is estimated to be delayed by more than a configured threshold. It then sends update alerts if the delay changes by more than a configured number of minutes.

There are different reasons that this alert would be triggered:

  1. An initial update alert is sent if the last arriving flight of a leg is estimated to be delayed beyond the scheduled gate arrival by more than a set number of minutes. The amount of time that a flight must be delayed before this alert is sent can be configured through your Cirium account representative.
  2. Update alerts are sent each time the arrival time for the last flight of a leg is changed a set number of minutes beyond the delay that triggered the previous alert. The amount that the arrival time must change before this alert is sent can also be configured through your Cirium account representative.

In this sample the final flight in the leg is arriving 19 minutes late.

Under the alertDetails attribute, you can see:
  • type is Leg Arrival Delay.
  • legIndex is 0 and flightIndex is 3. The alert is for the fourth flight in the first and only leg of the trip.
  • dateTime shows that the alert was sent at 2019-11-26T14:48:05.235278Z.
  • delay (current) is 19 minutes. There is no previous value. This means that this is the first time this alert was triggered for this leg.
Under the flightStatuses attribute for the flight you can see:
  • The scheduledGateDateTime for the flight is 2019-11-26T23:40:00.
  • The estimatedGateDateTime for the flight is 2019-11-26T23:59:00.
Leg Arrival Delay alert (click to display)

        

In this sample the flight was delayed an additional 26 minutes from the previous 19 minutes. The current delay is 45 minutes.

Under the alertDetails attribute, you can see:
  • type is Leg Arrival Delay.
  • legIndex is 0 and flightIndex is 3. The alert is for the fourth flight in the first and only leg.
  • dateTime shows that the alert was sent at 2019-11-26T15:21:38.853969Z.
  • delay (current) is 45 minutes. delay (previous) is 19. A previous alert was triggered for this leg, and the current delay 26 minutes longer than it was for that alert.
Under the flightStatuses attribute for the flight you can see:
  • The scheduledGateDateTime is 2019-11-26T23:40:00.
  • The estimatedGateDateTime is 2019-11-27T00:25:00.
Updated Leg Arrival Delay alert (click to display)

        
LEG ARRIVAL GATE CHANGE

The Leg Arrival Gate Change alert type is used to inform the traveler about the arrival of the last flight of each leg of a trip.

This alert type notifies the recipient if the terminal gate for the arrival of the last flight of a leg is changed. Alerts are sent out each time the gate changes after a set number of minutes before the scheduled arrival time of the arriving flight. The amount of time before the scheduled arrival can be configured through your Cirium account representative.


Under the alertDetails attribute, you can see:
  • type is Leg Arrival Gate Change.
  • legIndex is 2 and flightIndex is 0. The alert is for the first flight of the third leg.
  • dateTime shows that the alert was sent at 2019-11-29T23:21:49.097Z.
  • gate (current) is C3. gate (previous) is C7. This means that the gate has changed from C7 to C3.
Under the flightStatuses attribute for the flight you can see:
  • The gate attribute under arrival is set to C3.
Leg Arrival Gate Change alert (click to display)

        
LEG ARRIVAL INFO

The Leg Arrival Info alert type is used to inform the traveler about the arrival of the last flight of each leg of a trip.

There are different events that would result in this alert being triggered:

  1. An initial status alert is sent a set number of minutes before the scheduled gate arrival of the last flight of each leg. It serves as a notification or reminder about the arrival and includes current information about the trip. The amount of time that the alert is sent before the scheduled gate departure can be configured through your Cirium account representative.
  2. Update alerts are sent each time the arrival time for the last flight of a leg is delayed a set number of minutes. Update alerts are also sent if a delay is reduced that same number of minutes. The set number of minutes can be configured through your Cirium account representative. These alerts are only triggered after the initial status alert is sent.
  3. Update alerts are sent each time the arrival gate for the last flight of a leg is changed. These alerts are only triggered after the initial status alert is sent.

Note: Gate change events that are registered more than 1 hour before a flight is scheduled to arrive are buffered for 5 minutes before alerts are triggered. If another Leg Arrival Info update alert is sent within the 5 minute buffer period, the gate change alert will be included with it. These alerts are only triggered after the initial status alert is sent.


Under the alertDetails attribute, you can see:
  • type is Leg Arrival Info.
  • legIndex is 0 and flightIndex is 1. The alert is for the second and last flight in the first leg. This alert type will always apply to the last flight in the leg.
  • dateTime shows that the alert was sent at 2019-12-06T05:40:21.128683Z.
  • delay (current) is 0. There is no previous value. This means that this is the first time this alert was triggered for this leg, and the flight is currently estimated to arrive at the gate on time.
Under the flightStatuses attribute for the flight you can see:
  • The scheduledGateDateTime is 2019-12-06T15:40:00 (Okayama Airport time UTC+9) and the estimatedGateDateTime is 2019-12-06T15:40:00(UTC+9).
Leg Arrival Info alert (click to display)

        

In this sample, 7 minutes after the previous alert was sent, the flight was delayed 20 minutes from the previous 0 minute delay (20 minutes total).

Under the alertDetails attribute, you can see:
  • type is Leg Arrival Info.
  • legIndex is 0 and flightIndex is 1. The alert is for the second and last flight in the first leg. This alert type will always apply to the last flight in the leg.
  • dateTime shows that the alert was sent at 2019-12-06T05:47:59.616698Z.
  • delay (current) is 20 and delay (previous) is 0. This means that when this alert was previously triggered for this leg the delay was 0 minutes, and the current delay is 20 minutes.
Under the flightStatuses attribute for the flight you can see:
  • The scheduledGateDateTime is 2019-12-06T15:40:00 (UTC+9) and the estimatedGateDateTime is 2019-12-06T16:00:00 (UTC+9).
Updated Leg Arrival Info alert (click to display)

        
Under the alertDetails attribute, you can see:
  • type is Leg Departure Info.
  • dateTime shows that the alert was sent at 2019-12-06T06:03:02.638397Z.
  • legIndex is 0 and flightIndex is 1. The alert is for the arrival of the second and last flight in the first leg.
Under the flightStatuses attribute for the flight the gate is 8.
  • gate (current) is 8. gate (previous) is 4. The alert was triggered after the departure gate changed from 4 to 8.
Leg Arrival Info - Gate Change alert (click to display)

        


LEG ARRIVED

The Leg Arrived alert type notifies the recipient when the last flight of each leg has actually landed or arrived at the gate.


This example of a sent alert is for a trip with one leg that has just one flight.

Under the alertDetails attribute, you can see:
  • type is Leg Arrived.
  • legIndex is 0 and flightIndex is 3. The alert is for the fourth flight of the first and only leg of the trip.
  • dateTime shows that the alert was sent at 2019-11-26T12:50:33.08447Z.
Under the flightStatuses attribute for the flight you can see:
  • The flight was estimated to arrive at 2019-11-26T18:21:00 local airport time.
  • The flight status is Landed.
Leg Arrived alert (click to display)

        
LEG BAGGAGE CHANGE

The Leg Baggage Change alert type is used to inform the traveler about baggage terminal information for the arrival of the last flight of each leg of a trip.

Baggage terminal change events that occur within a set number of minutes of a flight's scheduled gate arrival trigger alerts. The set number of minutes can be configured through your Cirium account representative.

An alert will be sent for each baggage terminal change that occurs.


Under the alertDetails attribute, you can see:
  • type is Leg Baggage Change.
  • legIndex is 0 and flightIndex is 3. The alert is for the fourth flight of the first and only leg.
  • dateTime shows that the alert was sent at 2019-11-25T21:08:15.112173Z.
  • Under the flightStatuses attribute for the flight you can see the flight arrival baggage attribute is set to A2.
  • baggage (current) is 4. There is no previous value. This means that this is the first time this alert was triggered for this flight, and the baggage terminal is 4.
Leg Baggage Change alert (click to display)

        
Leg Departed

The Leg Departed alert type notifies the recipient when the first flight of each leg has actually departed from the gate or the runway.


Under the alertDetails attribute, you can see:
  • type is Leg Departed.
  • legIndex is 2 and flightIndex is 0. The alert is for the departure of the first flight of the second leg of the trip. For this alert, the flightIndex value will always be '0'.
  • dateTime shows that the alert was sent at 2019-12-07T06:40:07.826803Z.
Under the flightStatuses attribute for the flight you can see:
  • The first flight of the leg was scheduled to depart at 2019-12-07T01:25:00 local airport time (BOS airport -5 UTC). The flight became "Active" 15 minutes after the scheduled departure time.
Leg Departed alert (click to display)

        
LEG DEPARTURE DELAY

The Leg Departure Delay alert type is used to inform the traveler about the departure of the first flight of each leg of a trip.

This alert type notifies the recipient if the gate departure of the first flight of a leg is estimated to be delayed more than a configured threshold. It then sends update alerts if the delay changes by more than a configured amount.
There are different reasons that this alert would be triggered:

  1. An initial update alert is sent if the gate departure of the first flight of a leg is estimated to be delayed beyond the scheduled gate departure by more than a set number of minutes. The amount of time that a flight must be delayed before this alert is sent can be configured through your Cirium account representative.
  2. Update alerts are sent each time the departure time for the first flight of a leg is delayed a set number of minutes beyond the delay that triggered the previous alert. The amount of time that a flight must be delayed before this alert is sent can be configured through your Cirium account representative.

In this sample, the threshold for triggering the alert was 20 minutes (configured through your Cirium account representative).

Under the alertDetails attribute, you can see:
  • type is Leg Departure Delay.
  • legIndex is 1 and flightIndex is 0. The alert is for the first flight in the second leg.
  • dateTime shows that the alert was sent at 2019-11-26T15:09:19.066196Z.
  • delay (current) is 70 minutes. There is no previous value. This means that this is the first time this alert was triggered for this leg.
Under the flightStatuses attribute for the flight you can see:
  • The scheduledGateDateTime is 2019-11-26T12:50:00 and the estimatedGateDateTime is 2019-11-26T14:00:00.
Leg Departure Delay alert (click to display)

        

In this sample, after the previous alert was sent, the flight was delayed an additional 105 minutes from the previous 70 minute delay (175 minutes total).
Updated Leg Departure Delay alert (click to display)

        
LEG DEPARTURE GATE CHANGE

The Leg Departure Gate Change alert type is used to inform the traveler about the departure of the first flight of each leg of a trip.

This alert type notifies the recipient if the terminal gate for the departure of the first flight of a leg is changed. Alerts are sent out each time the gate changes for the departing flight.


Under the alertDetails attribute, you can see:
  • type is Leg Departure Gate Change.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight of the first leg.
  • dateTime shows that the alert was sent at 2019-11-26T11:01:31.359841Z.
  • gate (current) is E6. gate (previous) is E10. This means that the gate has changed from E10 to E6.
Under the flightStatuses attribute for the flight you can see:
  • The gate attribute under departure is set to E6.
Leg Departure Gate Change alert (click to display)

        
LEG DEPARTURE INFO

The Leg Departure Info alert type is used to inform the traveler about the departure of the first flight of each leg of a trip.
There are different events that would result in this alert being triggered:

  1. An initial status alert is sent a set number of minutes before the scheduled gate departure of the first flight of each leg. It serves as a notification or reminder about the departure and includes current information about the trip. The amount of time that the alert is sent before the scheduled gate departure can be configured through your Cirium account representative.
  2. Update alerts are sent each time the departure time for the first flight of a leg is delayed by a set number of minutes. Update alerts are also sent if a delay is reduced that same number of minutes. The set number of minutes can be configured through your Cirium account representative. These alerts are only triggered after the initial status alert is sent.
  3. Update alerts are sent each time the departure gate for the first flight of a leg is changed. These alerts are only triggered after the initial status alert is sent.

Note: Gate change events that are registered more than 1 hour before a flight is scheduled to depart are buffered for 5 minutes before alerts are triggered. If another Leg Departure Info update alert is sent within the 5-minute buffer period, the gate change alert will be included with it. These alerts are only triggered after the initial status alert is sent.


Under the alertDetails attribute, you can see:
  • type is Leg Departure Info.
  • legIndex is 0 and flightIndex is 0. The alert is for the first and only flight in the first and only leg.
  • dateTime shows that the alert was sent at 2019-12-10T05:47:07.896844Z. For the customer, the initial Leg Departure Info alert was configured to be sent 6 hours before the scheduled flight departure which is 2019-12-10T06:47:00.
  • delay (current) is 10 minutes. There is no previous value. This means that this is the first time this alert was triggered for this leg, and the flight is estimated to depart 10 minutes late. The "estimatedGateDateTime" is 2019-12-10T06:57:00.
Leg Departure Info alert (click to display)

        
Under the alertDetails attribute, you can see:
  • type is Leg Departure Info.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight in the first leg.
  • dateTime shows that the alert was sent at 2019-12-10T12:05:00.236049Z.
  • delay (current) is 58 minutes. delay (previous) is 10. In the previous sample, the alert was a scheduled reminder for the leg departure. For this sample, the change from a 10 minute delay to a 58-minute delay triggered the alert.
Leg Departure Info - Flight Delay alert (click to display)

        
Under the alertDetails attribute, you can see:
  • type is Leg Departure Info.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight in the first leg.
  • dateTime shows that the alert was sent at 2019-12-10T12:15:00.624511Z.
  • gate (current) is 33X. gate (previous) is 35X. The alert was triggered after the departure gate changed from 35X to 33X.
Leg Departure Info - Gate Change alert (click to display)

        
SCHEDULED ARRIVAL UPDATE

The Scheduled Arrival Update alert type is used to inform the traveler about the arrival of the last flight of each leg of a trip. It serves as a notification or reminder about the arrival and includes current information about the trip.

An update alert will be sent a set number of minutes before the last flight of each leg is scheduled to arrive at the gate. The set number of minutes (minutesBeforeArrival) can be configured through your Cirium account representative.


Under the alertDetails attribute, you can see:
  • type is Scheduled Arrival Update.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight in the first leg.
  • minutesBeforeArrival is set to 120.
  • The dateTime attribute shows that the alert was sent at 2019-12-10T06:40:09.248472Z.
Under the flightStatuses attribute for the connecting flights you can see:
  • The scheduledGateDateTime is 2019-12-10T09:40:00 (Geneva Airport time +1 UTC). The alert was sent 120 minutes before the flight was scheduled to arrive.
Scheduled Arrival Update alert (click to display)

        
SCHEDULED DEPARTURE UPDATE

The Scheduled Departure Update alert type is used to inform the traveler about the departure of the first flight of each leg of a trip. It serves as a notification or reminder about the departure and includes current information about the trip.

An update alert will be sent a set number of minutes before the first flight of each leg is scheduled to depart from the gate. The set number of minutes (minutesBeforeDeparture) can be configured through your Cirium account representative.


Under the alertDetails attribute, you can see:
  • type is Scheduled Departure Update.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight in the first leg.
  • minutesBeforeDeparture is set to 120.
  • The dateTime attribute shows that the alert was sent at 2019-12-10T09:30:07.362349Z.
Under the flightStatuses attribute for the connecting flights you can see:
  • The scheduledGateDateTime is set to 2019-12-10T06:30:00 (Baltimore time UTC-5). The alert was sent 120 minutes before the flight was scheduled to depart.
Scheduled Departure Update alert (click to display)

        
EXCEPTION WAIVER

The Exception Waiver alert type is used to inform agencies about Trips that might qualify for an exception waiver. This would be used to let travel support members know that a trip may be eligible for rebooking or refund with reduced or waived fees.

Exception Waiver Match alerts are triggered based on trips matching with waivers issued by airlines. Alerts are initially triggered for trips when they are found to match a waiver. A Waiver Match alert will not be generated for a trip if all matching flights have already departed. Waiver Match alerts are also triggered for trips that had previously matched a waiver, but no longer match. This can occur because a trip was updated (flight changed or removed), or if a waiver was updated or cancelled by Cirium or the issuing airline.
Among the data points that are applied to qualify a potential match are airline relationships (applicable booking and operating airlines), specific flights called out by the airline in their waiver policy, affected airports, affected travel dates, and ticketing requirements.


This is an example of an exception waiver "Match Added" alert for a waiver issued by Delta Airlines with trip matching based on airline relationships (applicable booking and operating airlines).

Under the alertDetails attribute, you can see:
  • dateTime is when the waiver was sent 2019-12-10T21:03:04.825625Z.
  • The type of alert is "Waiver Match". The alert was triggered based on a trip matching or unmatching a waiver.
  • legIndex is 0 and flightIndex is 0. The waiver matched the first flight in the first leg.
  • The waiver attribute includes the airline that issued the waiver DL, and the published exception policy which is broken out below.
  • issuingAirlineCode "DL" is the code for the airline that published and owns the waiver.
  • The waiverType "Exception Waiver" distinguishes the type of waiver alert (there is currently just one type of waiver match. We may support other types in the future).
Under the "waiver" attribute, the exceptionPolicy attribute includes details specified in the issued waiver and details regarding the criteria applied for matching the waiver to the flight. Under "exceptionPolicy", you can see:
  • waiverMatchReason shows qualifying attributes. This indicates if specific attributes were available, and how they were applied. Possible values for attributes under "waiverMatchReason" may include:
    • Data Not In Waiver indicates that the waiver issuing airline did not specify this information.
    • Data Not In Trip indicates that the trip in the Cirium system does not include the qualifying information.
    • Match indicates that the data in the waiver matches the data imported for the trip.
    • Mismatch indicates that the data in the waiver explicitly does not match the data for the trip.
    This example is for an alert where "waiverMatchStateChange" is "Match Added", meaning the waiver matched the trip.
    Under "waiverMatchReason":
    • Airlines reads "Match" because the combination of the booking/marketing airline and the operating airline matches one of the airline relationships specified in the waiver.
      Possible values for this attribute: "Data Not In Waiver", "Match" or "Mismatch".
    • Affected Airport reads "Match" because the flight went to/through/from an airport specified in the waiver.
      Possible values for this attribute: "Data Not In Waiver", "Match", or "Mismatch".
    • Travel Dates reads "Match" because the flight was scheduled to be active on an affected travel date specified in the waiver.
      This attribute will always be will always be "Match".
    • Ticket Issue Date reads "Match" because the PNR in the Cirium system includes ticket data specifying an issue date on or before the qualification specified in the waiver. Note: if a waiver does not specify an Issued on/before date, the value would have been "Data Not In Waiver".
      This attribute will always be will always be "Match".
    • Ticket Stock reads "Match" because the published waiver specified or strongly implied a required Ticket Stock and the trip includes a ticket with matching Ticket Stock.
      Possible values for this attribute: "Data Not In Waiver", "Data Not In Trip", "Match" or "Mismatch".
    • Specific Flight reads "Data Not In Waiver" because the waiver does not have any specific flights called out. Waivers typically apply to a set of affected airports and travel dates, or they apply to a set of specified flights.
      Possible values for this attribute: "Data Not In Waiver", "Match", or "Mismatch".
  • waiverMatchStateChange is "Match Added" because the flight on the trip was previously unmatched with the waiver. The other possible value for this attribute is "Match Removed". "Match Removed" is applied if the flight or waiver criteria were updated so that the match is no longer applicable.
  • id is a Cirium internal waiver identifier. All waivers in the Cirium waiver service have a unique integer id.
  • The waiverURL is for a Cirium hosted page that includes some waiver detail. The page requires a login typically includes a link to a PDF with full waiver detail when available. In this example the URL is 'https://trip.flightstats.com/waivers/1775'
  • name is the simple descriptive name given to a waiver by the issuer. It will typically be unique for each version of a waiver that the issuer published.
  • description includes a block of readable text that describes aspects of a waiver. It may also include special high level instructions.
  • category is a short description of the nature of the waiver, and it is Civil Unrest in this example.
  • publishedDate is the date that the waiver was published by the airline.
  • The cabinToCabinCode (optionally provided by airline) is a unique identifier provided by an airline for use with waiver submissions.
  • The waiveChangeFeeCode (optionally provided by airline) is a unique identifier provided by an airline for use with waiver submissions.
  • waiverVersion is a Cirium internal waiver version identifier. This integer starts with 0 and is incremented every time a waiver is updated in the Cirium waiver service, no matter how small the change.
  • waiverCode (optionally provided by airline) is a unique identifier provided by an airline for use with waiver submissions. (it was not applied in this example).
  • endorsementBoxPolicy (optionally provided by airline) is a unique identifier provided by an airline for use with waiver submissions. (it was not applied in this example).
  • osiRequirements (optionally provided by airline) is a unique and explicit identifier provided by an airline for use with waiver submissions.
  • The airlineRelationships (optional) is a list of groupings of airline codes that is used to do detailed and flexible airline code matching when specified in a waiver. Each relationship can include a list of booking/marketing airline codes, a list of operating airline codes, or both when applicable. This sample lists just one booking and one operating airline (Delta (DL) booked and Delta (DL) operated), and both happen to be the airline that issued the waiver.
  • bookingOrMarketingAirlineCodes and operatingAirlineCodes are lists of applicable FlightStats airline codes under airlineRelationships.
  • The specificFlights (optional and not applied in this sample) is a list of particular flights called out in the waiver as being applicable. Each flight contains the airline code, flight number (optional), departure airport, departure date, arrival airport, and arrival date.
  • The firstEffectiveTravelDate is the first date in the range of dates for which a waiver is applicable if it matches the scheduled arrival or departure date of a flight.
  • The lastEffectiveTravelDate is the last date in the range of dates for which a waiver is applicable if it matches the scheduled arrival or departure date of a flight.
  • firstNewTravelDate is the first date in the range of dates allowable for rescheduling a flight with waived fees.
  • lastNewTravelDate is the last date in the range of dates allowable for rescheduling a flight with waived fees.
  • newTravelDatesDetails is a human readable description of the first and last new travel dates allowable for rescheduling a flight with waived fees.
  • affectedAirportCodes is a list of airports applicable to the waiver.
  • systemWide is false because the waiver is applicable to a limited set of airports, as opposed to being globally applicable.
  • ticketStocks is a list of three digit ticket stocks specified that must match those on the tickets for cases in which ticket information is provided with trip data. In this sample there is a single ticket stock number in the list.
  • reissueTicketOnBefore is the last date by which a ticket must be reissued to get fees waived.
  • refundsApplicable is true because the published waiver read that refunds are available.
  • additinalInfo includes a block of readable text that describes aspects of a waiver. It may contain supplementary information or airline policy.
  • policyLinks includes a list of named URL links to airline information or service pages. These links are provided by Cirium as a helpful reference. They are not necessarily specified in the waiver.
Exception Waiver Match Added alert (click to display)

        


Any time a waiver in the Cirium system is updated so that no flight in a previously matched trip matches, a "Waiver Match" alert is sent. In this case where a previously matched waiver is no longer a match, the waiverMatchStateChange attribute value is Match Removed. This can occur if functional qualifying criteria are changed in the trip or waiver, or if the waiver status is "CANCELLED" by Cirium or the issuing airline.
The following is an example of an exception waiver "Match Removed" alert for a waiver issued by Iberia Airlines with trip matching based on specific flights called out in the waiver. In this case, Iberia Airlines announced that strike threat was retracted and the waiver policy is now cancelled.

Exception Waiver Match Removed alert (click to display)

        

The following is an example of an alert for an exception waiver issued by Iberia where the waiver included "specific flights" that would qualify for the waiver.

Under the exceptionPolicy attribute, you can see specificFlights which is used instead of airlineRelationships when a waiver calls out qualifying flights by flight number.
In this case, the waiver called out the flights BA 154 and BA 155 departing on 2019-08-18 and 2019-08-19 respectively.
Exception Waiver alert with Specific Flights(click to display)

        

WAIVER UPDATE

The Waiver Update alert type is used to inform subscribers that a new exception waiver has been issued by an airline, or an existing waiver has had a significant update related to qualifications. It is a resource for subscribers to stay informed of waivers issued by any airline supported by Cirium's waiver system. This alert is only available via email and is not intended for travelers.

The emailed alert includes abbreviated waiver content:

  • The issuing airline
  • The name used to identify the waiver
  • The impacted travel date rage
  • Affected airports or regions.
  • A link to a more detailed representation of the waiver. (access is restricted to subscribers)

TRIP REMINDER

The Trip Reminder alert type is used to inform travelers that a leg of a trip is about to begin.

An alert will be sent at a designated amount of time prior to the departure of the first flight of the upcoming trip leg. This amount of time is an alert setting that can be changed. Please contact your support representative for more information about this setting.


Under the tripReminderDetails attribute, you can see:
  • The dateTime the alert was sent 2019-12-11T20:45:11.747428Z.
  • The type of alert is Trip Reminder. The alert was triggered because the first flight in a trip's leg will depart soon.
  • In this example, the Trip Reminder was set to be triggered 24 hours before the first flight of the upcoming leg which was scheduled to depart 2019-12-12T12:45:00 Los Angeles time (UTC -8).
  • The legIndex is 0 and flightIndex is 0. The alert is for the first flight of the first leg of the trip.
  • The airline attribute includes information about airline for the departing flight of the leg that triggered the alert. This includes links to web check-in, baggage information, and terms of carriage.
Trip Reminder alert (click to display)