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 it's 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 FlightStats to to uniquely identify the alert.
  • Arrival and departure times located within the flightStatuses reference local airport time.
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 two flights.
Under the alertDetails attribute, you can see:
  • type is Actual Connection Problem.
  • The alert is for the connection of the first and second flight in the leg.
    legIndex is 0
    inboundFlightIndex is 0
    outboundFlightIndex is 1
  • The dateTime attribute shows that the alert was sent at 2015-10-26T22:07:44.646Z.
  • The connectionTime (current) is 1 minute.
  • The minimumConnectTime is 50. 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 first flight actually arrived at 2015-10-26T17:47:00.
  • The second flight actually departed at 2015-10-26T17:48: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 FlightStats 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 set number of minutes can be configured through your FlightStats 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 two 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 FlightStats 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 2016-12-14T16:36:05.967Z.
  • The connectionTime (current) is -33 minutes, indicating that the outbound flight may depart before the inbound flight arrives.

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 estimated to arrive at 2016-12-14T09:36:00 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 2016-12-14T11:06:00. The scheduled departure time for the departing flight in the connection is 2016-12-14T10:33: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 from the previous alert by more than a 10 minutes. This number of minutes can be configured through your FlightStats account representative.

Under the alertDetails attribute, you can see:
  • In this sample, the flight has two legs, with two 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.
    legIndex is 1
    inboundFlightIndex is 0
    outboundFlightIndex is 1
  • The dateTime attribute shows that the alert was sent at 2016-12-14T16:41:27.832Z.
  • The connectionTime includes a current and previous time.
    In this case, the connection time is 14 minutes more than it was with the previous alert. It was -33 and currently it is -19. Note that in this case the connection time is still a negative number of minutes, indicating that the outbound flight may depart 19 minutes before the inbound flight arrives, and the connection is at risk.
Under the flightStatuses attribute for the connecting flights you can see:
  • The first flight is estimated to arrive at 2016-12-14T11:06:00.
  • The second flight is estimated to depart at 2016-12-14T10:47: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 two 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.
    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 2016-12-14T17:05:40.066Z.
  • gate (current) is 46 and gate (previous) is 41, so the gate had just changed from 41 to 46
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. FlightStats 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.


The connection in this example is at risk. The flight has one leg with three flights.
Under the alertDetails attribute, you can see:
  • type is Estimated Connection Problem.
  • legIndex is 0
  • inboundFlightIndex is 0 and outboundFlightIndex is 1.
    The alert is for the connection of the first and second flight in the leg.
  • dateTime shows that the alert was sent at 2016-04-28T15:48:18.376Z.
  • connectionTime (current) is 10 minutes.
  • minimumConnectTime is 50. 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 first flight is estimated to arrive at 2016-04-28T11:02:00.
  • The scheduled departure time for the departing flight in the connection is 2016-04-28T11:12: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 FlightStats 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 of time that a flight must be delayed before this alert is sent can also be configured through your FlightStats account representative.

Under the alertDetails attribute, you can see:
  • type is Flight Arrival Delay.
  • legIndex is 0 and flightIndex is 1. The alert is for the second flight in the leg.
  • dateTime shows that the alert was sent at 2016-04-28T19:39:50.529Z.
  • delay (current) is 23 minutes. There is no previous value. This means that this is the first time this alert was triggered for this flight. The flight is delayed 23 minutes.
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 FlightStats 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 2016-04-28T17:43:33.867Z.
  • gate (current) is 55B. There is no previous value. This means that this is the first time this alert was triggered for this flight, and the arrival gate is 55B.
Flight Arrival Gate Change 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 has one leg with two flights in the trip.

Under the alertDetails attribute, you can see:
  • type is Flight Arrived.
  • 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 2016-04-28T19:41:07.068Z.
Flight Arrived 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 FlightStats 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 2016-04-28T19:42:58.473Z.
  • baggage (current) is A3. 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 A3.
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 second flight in a one leg trip.

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.

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 0 and flightIndex is 1. The alert is for the second flight in the leg.
  • dateTime shows that the alert was sent at 2016-04-28T20:47:03.724Z.
Flight Departed 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 FlightStats 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 FlightStats account representative.

Under the alertDetails attribute, you can see:
  • type is Flight Departure Delay.
  • legIndex is 0 and flightIndex is 1. The alert is for the second flight in the leg.
  • dateTime shows that the alert was sent at 2016-04-28T19:56:08.345Z.
  • delay (current) is 25 minutes. delay (previous) value is 12. This means that the flight was delayed 12 minutes when the previous alert was sent, and the flight was delayed an additional 13 minutes.
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 FlightStats 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 0. The alert is for the first flight of the trip.
  • dateTime shows that the alert was sent at 2016-04-28T17:43:33.867Z.
  • gate (current) is 55B. There is no previous value. This means that this is the first time this alert was triggered for this flight, and the departure gate is 55B.
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 FlightStats 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 2016-04-28T15:46:55.761Z.
  • minutesBeforeDeparture is 60. In this sample, the alert was set to be sent 60 minutes before each flight departure.
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 Indianapolis International Airport (IND) was diverted to Cincinnati/Northern Kentucky Airport (CVG).

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 0. The alert is for the first flight of the trip.
  • dateTime shows that the alert was sent at 2016-07-07T11:10:07.159Z.
Under the flightStatuses attribute, you can see:
  • diverted is "airportCode": "ORD".
Flight Diversion alert (click to display)

        
LEG ARRIVAL DELAY

The Leg Arrival Delay 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 gate arrival of the last 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.
The configured amounts of time that a leg arrival must be delayed before an alert is sent can be configured through your FlightStats account representative.

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 FlightStats 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 be configured through your FlightStats account representative.

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

Under the alertDetails attribute, you can see:
  • type is Leg Arrival Delay.
  • 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 2016-04-09T17:58:18.458Z.
  • delay (current) is 25 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 2016-04-10T14:25:00.
  • The estimatedGateDateTime is 2016-04-10T14:50:00.
Leg Arrival Delay alert (click to display)

        

In this sample the flight was delayed an additional 15 minutes from the previous 25 minutes. The current delay is 40 minutes.

Under the alertDetails attribute, you can see:
  • type is Leg Arrival Delay.
  • 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 2016-04-10T12:58:18.458Z.
  • delay (current) is 40 minutes. delay (previous) is 25. A previous alert was triggered for this leg, and the current delay 15 minutes longer than it was for that alert.
Under the flightStatuses attribute for the flight you can see:
  • The scheduledGateDateTime is 2016-04-10T14:25:00.
  • The estimatedGateDateTime is 2016-04-10T15:05: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 for the arriving flight.


Under the alertDetails attribute, you can see:
  • type is Leg Arrival Gate Change.
  • legIndex is 0 and flightIndex is 0. The alert is for the first (and only) flight of the first leg.
  • dateTime shows that the alert was sent at 2016-04-28T19:21:25.122Z.
  • gate (current) is 32A. gate (previous) is 32E. This means that the gate has changed from 32E to 32A.
Under the flightStatuses attribute for the flight you can see:
  • The gate attribute under arrival is set to 32A.
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 FlightStats 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 FlightStats 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 1 and flightIndex is 2. The alert is for the third flight in the second leg.
  • dateTime shows that the alert was sent at 2015-07-08T22:04:55.404Z.
  • 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 2015-07-08T15:04:00 and the estimatedGateDateTime is 2015-07-08T15:04:00.
Leg Arrival Info alert (click to display)

        

In this sample, 11 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 1 and flightIndex is 2. The alert is for the third flight in the second leg.
  • dateTime shows that the alert was sent at 2015-07-08T22:15:55.404Z.
  • 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 2015-07-08T15:04:00 and the estimatedGateDateTime is 2015-07-08T15:24:00.
Updated Leg Arrival Info alert (click to display)

        
Under the alertDetails attribute, you can see:
  • type is Leg Departure Info.
  • legIndex is 1 and flightIndex is 2. The alert is for the third flight in the second leg.
  • dateTime shows that the alert was sent at 22015-07-08T22:45:55.404Z.
  • gate (current) is N5. gate (previous) is N7. The alert was triggered after the departure gate changed from N5 to N7.
Under the flightStatuses attribute for the flight you can see:
  • The gate is N5.
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 0. The alert is for the first flight of the first leg of the trip.
  • dateTime shows that the alert was sent at 2016-04-28T19:42:08.722Z.
Under the flightStatuses attribute for the flight you can see:
  • The flight was estimated to arrive at 2016-04-28T12:54:00 local airport time.
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 FlightStats 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 0. The alert is for the first (and only) flight of the first leg.
  • dateTime shows that the alert was sent at 2016-04-28T17:51:45.994Z.
  • baggage (current) is A2. 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 A2.
Under the flightStatuses attribute for the flight you can see:
  • The flight arrival baggage attribute is set to A2.
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.


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 Departed.
  • legIndex is 0 and flightIndex is 0. The alert is for the first flight of the first leg of the trip.
  • dateTime shows that the alert was sent at 2015-09-21T07:00:33.152Z.
Under the flightStatuses attribute for the flight you can see:
  • The first flight of the leg was scheduled to depart at 2015-09-21T14:35:00 local airport time (HKG airport).
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 FlightStats 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 FlightStats account representative.

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

Under the alertDetails attribute, you can see:
  • type is Leg Departure Delay.
  • 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 2016-05-02T16:37:35.009Z.
  • delay (current) is 30 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 2016-05-02T14:52:00 and the estimatedGateDateTime is 2016-05-02T15:22:00.
Leg Departure Delay alert (click to display)

        

In this sample, after the previous alert was sent, the flight was delayed an additional 12 minutes from the previous 30 minute delay (42 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 (and only) flight of the first leg.
  • dateTime shows that the alert was sent at 2016-04-28T17:36:25.011Z.
  • gate (current) is 55A. gate (previous) is 55C. This means that the gate has changed from 55C to 55A.
Under the flightStatuses attribute for the flight you can see:
  • The gate attribute under departure is set to 55A.
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 FlightStats 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. 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 FlightStats 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 flight in the first leg.
  • dateTime shows that the alert was sent at 2016-04-20T19:54:05.330Z.
  • delay (current) is 0 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 be on time.
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 2016-04-21T19:50:18.458Z.
  • delay (current) is 15 minutes. delay (previous) is 0. In the previous sample, the alert was a scheduled reminder for the leg departure. For this sample, the 15 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 2016-04-21T19:52:12.123Z.
  • gate (current) is A2. gate (previous) is A1. The alert was triggered after the departure gate changed from A1 to A2.
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 FlightStats 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 60.
  • The dateTime attribute shows that the alert was sent at 2016-04-28T18:50:24.600Z.
Under the flightStatuses attribute for the connecting flights you can see:
  • The scheduledGateDateTime is set to 2016-04-28T12:50:00. 60 minutes after the alert was sent.
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 FlightStats 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 60.
  • The dateTime attribute shows that the alert was sent at 2016-04-28T16:55:58.761Z.
Under the flightStatuses attribute for the connecting flights you can see:
  • The scheduledGateDateTime is set to 2016-04-28T10:55:00. 60 minutes after the alert was sent.
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. Match Removed alerts are 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. Among the data points that are applied to qualify a potential match are the booking/marketing airline, operating airline, affected airports, affected travel dates, ticketing requirements, and any specific flights that are called out in the waiver.

Please note that this part of the API is currently experimental, and as such may be subject to frequent changes.


This is an example of an exception waiver "Match Added" alert for a waiver issued by Delta Airlines.

Under the alertDetails attribute, you can see:
  • The dateTime the waiver was sent.
  • The type of alert is "Waiver Match". The alert was triggered based on a trip matching a waiver.
  • legIndex is 0 and flightIndex is 0. This indicates that the flight that matched the waiver is the first fight of the first leg of the trip.
  • The issuingAirlineCode is the code for the airline that published and owns the waiver.
  • The waiverType "Exception Waiver" distinguishes the alert from a "standing policy" waiver alert (see "Standing Policy" alert samples on this page).
  • The waiver attribute includes the airline that issued the waiver, the type of waiver that triggered the alert, and exception policy which is broken out below.

Under the "waiver" attribute, the exceptionPolicy attribute includes details specified in the issued waiver and details regarding the criteria applied to the matched flight. Under the attribute, you can see:
  • The waiverMatchStateChange is "Match Added" because the flight on the trip was previously unmatched with the waiver. Other possible values for this attribute are "Match Removed" and "Match Changed". "Match Removed" is applied if the flight or waiver criteria were updated so that the match is no longer applicable. "Match Changed" is applied if the "refundable" attribute changes to false. (see "refundable" below)
  • The waiverId is a FlightStats internal waiver identifier. All waivers in the FlightStats waiver service have a unique integer id.
  • The waiverVersion is a FlightStats internal waiver version identifier. This number is incremented every time a waiver is updated in the FlightStats waiver service, no matter how small the change.
  • The waiverName is the simple descriptive name given to a waiver by the issuer. It will be unique for each version of a waiver that the issuer published.
  • The waiverURL is a FlightStats hosted page that includes some waiver detail. It will include a link to a PDF with full waiver detail when available.
  • Note that the URLs in samples are not necessarily live. Example WaiverURL value: 'https://trip.flightstats.com/WD/194'
  • 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.
  • The airlineRelationships 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.
  • The specificFlights 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 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.
  • The refundable is True if the issuing airline has a policy to always refund when a waiver is applicable to a flight.
  • The waiverMatchCriteriaApplication is a set of criteria applied between waivers and flights in trips to determine a match that would trigger an alert.
Possible values for the following attributes under "waiverMatchCriteriaApplication" 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 Flightstats 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.
  • Excluded is True if the waiver indicates that the criteria should not be applied to determine a match.

  • The following example is for an alert where "waiverMatchStateChange" is "Match Added". Under "waiverMatchCriteriaApplication":

    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 active on an affected travel date specified in the waiver.
    This attribute will always be will always be "Match".
    Ticket Stock reads "Match" because the published waiver specied 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.
    Possible values for this attribute: "Data Not In Waiver", "Match", or "Mismatch".
Exception Waiver Match Added alert (click to display)

        
Exception Waiver Match Removed alert (click to display)

        

WAIVER UPDATE

The Waiver Update alert type is used to inform agencies that a new exception waiver has been issued by an airline, or an existing one has had a significant update. It serves as a single source for agents to stay informed of waivers issued by any supported airline.

An alert will be sent any time a new waiver has been issued, or an existing one has had a change to any field that affects how trips qualify for matching the waiver.


Under the alertDetails attribute, you can see:
  • The dateTime the alert was sent.
  • The type of alert is Waiver Update. The alert was triggered due to a new or updated exception waiver.
  • The waiver attribute includes the airline that issued the waiver, the type of waiver that triggered the alert, and the full details of the waiver.
Exception Waiver Update alert (click to display)

        
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.
  • The type of alert is Trip Reminder. The alert was triggered because the first flight in a trip's leg will depart soon.
  • 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)