Monitoring airport demand using the TFMData Service

The TFMDataService supports functionality to maintain airport demand lists. The process for acquiring the initial list and maintaining the list is a two-step process. The first step is to submit a Request/Reply request to register for the airport monitor function and the second step is to monitor the TFMDataService Flow Information feed for subsequent actions for flights in the list. To submit a valid tfmRequestReply airport monitor request message to TFMS there are certain JMS properties and message elements / attributes that are required, see Required Elements in all TFMData Requests.

Each registration contains a specified duration, which is the amount of time in hours you wish to keep receiving Flow Information updates for that airport. You cannot re-register to monitor the same airport in the same manner (arrivals, departures or all) while a previous registration duration is still in effect. A subsequent Request/Reply message can be sent to de-register your airport monitor prior to expiration of the duration. There are also TFMS-imposed restrictions for how often an airport monitor request can be entered.

TFMData Airport Monitor Requests

In addition to the JMS properties and message elements that are required for all TFMData Requests, there are additional elements that may be included and are only applicable for an airport monitor request as indicated in the following table.

Schema Element	Required/ Optional	Description	Sample Value
tfmDataService.tfmRequestReply.request.arptRequest.register	Optional	Indicates the arptRequest desired action. One of register or deregister must be present.
tfmDataService.tfmRequestReply.request. arptRequest.deregister	Optional	Indicates the arptRequest desired action. One of register or deregister must be present.
tfmDataService.tfmRequestReply.request.arptRequest.register.duration	Optional	For register requests, this indicates the duration of the monitor action. If duration expires and there are no more users monitoring the airport, the Flow Information updates will no longer take place.
tfmDataService.tfmRequestReply.request.arptRequest.register.airports.monType	Required	Indicates whether this monitor request is for AIRPORT_ARRIVALS, AIRPORT_DEPARTURES or AIRPORT_ALL.	AIRPORT_ALL
tfmDataService.tfmRequestReply.request.arptRequest.register.airports.airport	Required	Indicated the airport to monitor.	ORD

TFMData Reply

In response to a valid Airport Monitor request, the requestor will receive one or more replies containing the initial flight list for the monitored airport. If the list includes a large number of flights, it will be sent in separate JMS messages as multiple replies. Replies with a <status> of PROCESSING indicate that the airport monitor flights have not yet finished. A final reply with a <status> of SUCCESS indicates completion of the initial flight list.

All TFMData replies have several common elements as described in Common TFMData Reply Elements. The following table provides a description of the unique elements received in an Airport Monitor request reply.

Schema Element	Required/ Optional	Description	Sample Value
tfmDataService.tfmRequestReply.reply.flowFlightData.flightDataList	Optional	Contains a series of elements describing a single flight.	See TFMDataService schema
tfmDataService.tfmRequestReply.reply.flowFlightData.flightDataList.flight	Optional	The flight identification section of one flightDataList	See TFMDataService schema

Schema Element

Required/ Optional

Description

Sample Value

tfmDataService.tfmRequestReply.reply.flowFlightData.flightDataList

Optional

Contains a series of elements describing a single flight.

See TFMDataService schema

tfmDataService.tfmRequestReply.reply.flowFlightData.flightDataList.flight

Optional

The flight identification section of one flightDataList

See TFMDataService schema

TFM Data Flow Information Feed

After completing the request/reply exchange to establish an airport monitor and receiving the initial flight list, users who wish to maintain a dynamic flight list need to use the TfmDataService Flow Information Feed. Flow Information is a separate NEMS-provided feed that TFMS uses to publish TMI related information as well as flight data that is included in the TMI.

For airport monitoring, it is best to begin listening on the Flow Information feed before issuing the airport monitor request. Any flight list updates over Flow Information that have a timestamp later than the first received response should be retained and applied to the flight list returned in the initial reply. This ensures that no updates to the demand list of the monitored airport will be missed.

Flow information messages that apply to this airport monitor will have the following values:

The msgType JMS property and the msgType attribute of the tfmDataService.fiOutput.fiMessage element are equal to TMI_FLIGHT_LIST
The tfmDataService.fiOutput.fiMessage.tmiFlightListData.flightData.flight.departurePoint.airport element matches the airport being monitored for DEPARTURES or ALL
The tfmDataService.fiOutput.fiMessage.tmiFlightListData.flightData.flight.arrivalPoint.airport element matches the airport being monitored for ARRIVALS or ALL
The tfmDataService.fiOutput.fiMessage.tmiFlightListData.flightData. hasMonitoredDepApt equals true for airports being monitored for DEPARTURES or ALL
The tfmDataService.fiOutput.fiMessage.tmiFlightListData.flightData. hasMonitoredArrApt equals true for airports being monitored for ARRIVALS or ALL

For the purpose of monitoring the airport demand and maintaining a flight list, any Flow Information messages that do not meet the criteria above can be ignored.

See the TFMDataService schema for details of the Flow Information feed.

Sample Airport Monitor(ARPTM) request:

<n1:tfmDataService xmlns="urn:us:gov:dot:faa:atm:tfm:ficommonmessages"
                   xmlns:fcm2="urn:us:gov:dot:faa:atm:tfm:ficommonmessages2"
                   xmlns:fdm="urn:us:gov:dot:faa:atm:tfm:flightdata"
                   xmlns:tds="urn:us:gov:dot:faa:atm:tfm:tfdmservice"
                   xmlns:frt="urn:us:gov:dot:faa:atm:tfm:rapttimeline"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:n1="urn:us:gov:dot:faa:atm:tfm:tfmdataservice"
                   xmlns:fim="urn:us:gov:dot:faa:atm:tfm:flowinformation"
                   xmlns:iade="urn:us:gov:dot:faa:atm:tfm:iademessagetypes"
                   xmlns:fce="urn:us:gov:dot:faa:atm:tfm:ficommondatatypes"
                   xmlns:nxce="urn:us:gov:dot:faa:atm:tfm:tfmdatacoreelements"
                   xmlns:trr="urn:us:gov:dot:faa:atm:tfm:tfmrequestreplytypes"
                   xmlns:idm="urn:us:gov:dot:faa:atm:tfm:internationalflightdata"
                   xmlns:nxcm="urn:us:gov:dot:faa:atm:tfm:flightdatacommonmessages"
                   xsi:schemaLocation="urn:us:gov:dot:faa:atm:tfm:tfmdataservice TFMData_Service.xsd">
   <n1:tfmRequestReply>
      <n1:request serviceCode="ARPTM">
         <trr:requestId>
            <trr:requestor>
               <fcm2:center>AAL</fcm2:center>
               <fcm2:requestorId>server_01</fcm2:requestorId>
            </trr:requestor>
            <trr:uniqueMsgId>25048748-b3c1-419e-8bea-7bf664bd92eb</trr:uniqueMsgId>
         </trr:requestId>
         <trr:arptRequest>
            <trr:register>
               <trr:duration>2</trr:duration>
               <trr:airports>
                  <trr:monType>AIRPORT_DEPARTURES</trr:monType>
                  <trr:airport>MIA</trr:airport>
               </trr:airports>
            </trr:register>
         </trr:arptRequest>
      </n1:request>
   </n1:tfmRequestReply>
</n1:tfmDataService>

Sample Airport Monitor(ARPTM) reply (first of multiple):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:tfmDataService xmlns:ns16="http://www.fixm.aero/flight/3.0" xmlns:ns14="http://www.fixm.aero/base/3.0" xmlns:ns15="http://www.fixm.aero/foundation/3.0" xmlns:ns9="urn:us:gov:dot:faa:atm:tfm:tfmrequestreplytypes" xmlns:ns5="http://www.fixm.aero/tfm/3.1" xmlns:ns12="urn:us:gov:dot:faa:atm:tfm:flowinformation" xmlns:ns6="urn:us:gov:dot:faa:atm:tfm:tfmdatacoreelements" xmlns:ns13="urn:us:gov:dot:faa:atm:tfm:rapttimeline" xmlns:ns7="http://www.faa.aero/nas/3.1" xmlns:ns10="urn:us:gov:dot:faa:atm:tfm:ficommonmessages" xmlns:ns8="urn:us:gov:dot:faa:atm:tfm:ficommonmessages2" xmlns:ns11="urn:us:gov:dot:faa:atm:tfm:ficommondatatypes" xmlns:ns2="urn:us:gov:dot:faa:atm:tfm:flightdatacommonmessages" xmlns:ns4="urn:us:gov:dot:faa:atm:tfm:tfmdataservice" xmlns:ns3="urn:us:gov:dot:faa:atm:tfm:flightdata">
    <ns4:tfmRequestReply>
        <ns4:reply>
            <ns9:requestId>
                <ns9:requestor>
                    <ns8:center>AAL</ns8:center>
                    <ns8:requestorId> server_01</ns8:requestorId>
                </ns9:requestor>
                <ns9:uniqueMsgId>25048748-b3c1-419e-8bea-7bf664bd92eb</ns9:uniqueMsgId>
            </ns9:requestId>
            <ns9:status>PROCESSING</ns9:status>
            <ns9:flowFlightData>
                <ns8:flightDataList>
                    <ns8:flight>
                        <ns6:aircraftId>EGF4924</ns6:aircraftId>
                        <ns6:igtd>2016-06-07T17:06:00Z</ns6:igtd>
                        <ns6:departurePoint>
                            <ns6:airport>MIA</ns6:airport>
                        </ns6:departurePoint>
                        <ns6:arrivalPoint>
                            <ns6:airport>MYGF</ns6:airport>
                        </ns6:arrivalPoint>
                    </ns8:flight>
                    <ns8:flightReference>2842010</ns8:flightReference>
                    <ns8:status>PLANNED</ns8:status>
                    <ns8:engineClass>TURBO</ns8:engineClass>
                    <ns8:weightClass>LARGE</ns8:weightClass>
                    <ns8:aircraftCategory>MULTI_TURBO_PROP</ns8:aircraftCategory>
                    <ns8:userCategory>COMMERCIAL</ns8:userCategory>
                    <ns8:IGTA>2016-06-07T17:56:00Z</ns8:IGTA>
                    <ns8:SGTD>2016-06-07T17:06:00Z</ns8:SGTD>
                    <ns8:SGTA>2016-06-07T17:56:00Z</ns8:SGTA>
                    <ns8:LGTD>2016-06-07T17:12:00Z</ns8:LGTD>
                    <ns8:LGTA>2016-06-07T18:02:00Z</ns8:LGTA>
                    <ns8:LRTD>2016-06-07T17:27:00Z</ns8:LRTD>
                    <ns8:LRTA>2016-06-07T17:55:00Z</ns8:LRTA>
                    <ns8:ERTD>2016-06-07T17:27:00Z</ns8:ERTD>
                    <ns8:ERTA>2016-06-07T17:55:00Z</ns8:ERTA>
{section omitted}.
                </ns8:flightDataList>
            </ns9:flowFlightData>
        </ns4:reply>
    </ns4:tfmRequestReply>

Sample Airport Monitor(ARPTM) reply (last of multiple):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:tfmDataService xmlns:ns16="http://www.fixm.aero/flight/3.0" xmlns:ns14="http://www.fixm.aero/base/3.0" xmlns:ns15="http://www.fixm.aero/foundation/3.0" xmlns:ns9="urn:us:gov:dot:faa:atm:tfm:tfmrequestreplytypes" xmlns:ns5="http://www.fixm.aero/tfm/3.1" xmlns:ns12="urn:us:gov:dot:faa:atm:tfm:flowinformation" xmlns:ns6="urn:us:gov:dot:faa:atm:tfm:tfmdatacoreelements" xmlns:ns13="urn:us:gov:dot:faa:atm:tfm:rapttimeline" xmlns:ns7="http://www.faa.aero/nas/3.1" xmlns:ns10="urn:us:gov:dot:faa:atm:tfm:ficommonmessages" xmlns:ns8="urn:us:gov:dot:faa:atm:tfm:ficommonmessages2" xmlns:ns11="urn:us:gov:dot:faa:atm:tfm:ficommondatatypes" xmlns:ns2="urn:us:gov:dot:faa:atm:tfm:flightdatacommonmessages" xmlns:ns4="urn:us:gov:dot:faa:atm:tfm:tfmdataservice" xmlns:ns3="urn:us:gov:dot:faa:atm:tfm:flightdata">
    <ns4:tfmRequestReply>
        <ns4:reply>
            <ns9:requestId>
                <ns9:requestor>
                    <ns8:center>AAL</ns8:center>
                    <ns8:requestorId>arptmUsr_01</ns8:requestorId>
                </ns9:requestor>
                <ns9:uniqueMsgId>25048748-b3c1-419e-8bea-7bf664bd92eb</ns9:uniqueMsgId>
            </ns9:requestId>
            <ns9:status>SUCCESS</ns9:status>
            <ns9:flowFlightData>
                <ns8:flightDataList>
                    <ns8:flight>
                        <ns6:aircraftId>AAL2187</ns6:aircraftId>
                        <ns6:gufi>KR00000556</ns6:gufi>
                        <ns6:igtd>2016-06-07T13:21:00Z</ns6:igtd>
                        <ns6:departurePoint>
                            <ns6:airport>MIA</ns6:airport>
                        </ns6:departurePoint>
                        <ns6:arrivalPoint>
                            <ns6:airport>MMUN</ns6:airport>
                        </ns6:arrivalPoint>
                    </ns8:flight>
                    <ns8:flightReference>2824479</ns8:flightReference>
                    <ns8:status>ACTIVE</ns8:status>
                    <ns8:engineClass>JET</ns8:engineClass>
                    <ns8:weightClass>LARGE</ns8:weightClass>
{section omitted}.
                </ns8:flightDataList>
            </ns9:flowFlightData>
        </ns4:reply>
    </ns4:tfmRequestReply>

Flow Information message to maintain Airport Monitor flight list:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:tfmDataService xmlns:ns16="http://www.fixm.aero/flight/3.0" xmlns:ns14="http://www.fixm.aero/base/3.0" xmlns:ns15="http://www.fixm.aero/foundation/3.0" xmlns:ns9="urn:us:gov:dot:faa:atm:tfm:tfmrequestreplytypes" xmlns:ns5="http://www.fixm.aero/tfm/3.1" xmlns:ns12="urn:us:gov:dot:faa:atm:tfm:flowinformation" xmlns:ns6="urn:us:gov:dot:faa:atm:tfm:tfmdatacoreelements" xmlns:ns13="urn:us:gov:dot:faa:atm:tfm:rapttimeline" xmlns:ns7="http://www.faa.aero/nas/3.1" xmlns:ns10="urn:us:gov:dot:faa:atm:tfm:ficommonmessages" xmlns:ns8="urn:us:gov:dot:faa:atm:tfm:ficommonmessages2" xmlns:ns11="urn:us:gov:dot:faa:atm:tfm:ficommondatatypes" xmlns:ns2="urn:us:gov:dot:faa:atm:tfm:flightdatacommonmessages" xmlns:ns4="urn:us:gov:dot:faa:atm:tfm:tfmdataservice" xmlns:ns3="urn:us:gov:dot:faa:atm:tfm:flightdata">
    <ns4:fiOutput>
        <ns12:fiMessage sensitivity="A" destinationCodes="AAL" sourceFacility="TFMS" sourceTimeStamp="2016-06-07T16:00:17Z" msgType="TMI_FLIGHT_LIST">
            <ns12:tmiFlightDataList>
                <ns12:flightData>
                    <ns8:flight>
                        <ns6:aircraftId>AAL2016</ns6:aircraftId>
                        <ns6:gufi>KR00000017</ns6:gufi>
                        <ns6:igtd>2016-06-07T13:41:00Z</ns6:igtd>
                        <ns6:departurePoint>
                            <ns6:airport>MIA</ns6:airport>
                        </ns6:departurePoint>
                        <ns6:arrivalPoint>
                            <ns6:airport>LGA</ns6:airport>
                        </ns6:arrivalPoint>
                    </ns8:flight>
                    <ns8:flightReference>2826028</ns8:flightReference>
                    <ns8:status>ACTIVE</ns8:status>
                    <ns8:engineClass>JET</ns8:engineClass>
                    <ns8:weightClass>LARGE</ns8:weightClass>
                    <ns8:aircraftCategory>CIVILIAN_JET</ns8:aircraftCategory>
                    <ns8:userCategory>COMMERCIAL</ns8:userCategory>
                    <ns8:hasMonitoredDepApt>true</ns8:hasMonitoredDepApt>
                    <ns8:IGTA>2016-06-07T16:41:00Z</ns8:IGTA>
                    <ns8:ARTD>2016-06-07T14:00:00Z</ns8:ARTD>
                    <ns8:SGTD>2016-06-07T13:41:00Z</ns8:SGTD>
                    <ns8:SGTA>2016-06-07T16:41:00Z</ns8:SGTA>
                 ....{section omitted}....