Request Current Traffic Management Initiatives (TMIs) in TFMS via Request/Reply

As part of TFMData Service Request/Reply functionality, the capability to request a list of TMIs currently in the TFMS system is available. The list may include, Ground Delay Programs (GDP), Ground Stop (GS), Flight/Slot Compression, Blanket Delay, Flow Evaluation Areas (FEA) and Flow Control Areas (FCA), Airspace Flow Programs (AFP), CTOPs, and Reroutes. The specific types of TMIs to be included in the list returned is specified by the user in the request. In addition, the capability to request definition details and associated flight list for a specific TMI is also provided via Request/Reply using the tmiReferenceNumber returned in the TMI list response, see Request TMI Definition/Flight List via Request/Reply.

NOTE: For users listening on the NEMS Flow Information feed, once a TMI is created, the definition details of the TMI is published periodically by TFMS until the TMI expires. In addition, as flight data updates are processed for flights included in one or more of the TMIs, the updated flight information is also published over the Flow Information feed to NEMS. For examples of TMI definition and flight data update messages published over Flow Information, see Example Flow Information Data Feed Messages.

The following table lists the TFMData schema elements specific to a TMIlist request. The serviceCode request attribute for this request is TMILIST. For the detailed description of JMS properties and message elements/attributes that are required for all valid tfmRequestReply request messages to TFMS, see Required Elements in all TFMData Requests.

Schema Element	Required/ Optional	Description	Sample Value
tfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.ctop	Required	Boolean indicator set to true if the list should include CTOPs.	true
tfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.fxa	Required	Boolean indicator set to true if the list should include FEA/FCAs.	true
tfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.reroute	Required	Boolean indicator set to true if the list should include reroutes.	false
generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.afp	Required	Boolean indicator set to true if the list should include AFPs.	false
generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.gdp	Required	Boolean indicator set to true if the list should include GDPs.	false
generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.gs	Required	Boolean indicator set to true if the list should include Ground Stops.	false
generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.compression	Required	Boolean indicator set to true if the list should include Flight/Slot Compressions.	false
generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.blanket	Required	Boolean indicator set to true if the list should include Blanket Delays.	false

Schema Element

Required/ Optional

Description

Sample Value

tfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.ctop

Required

Boolean indicator set to true if the list should include
CTOPs.

true

tfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.fxa

Required

Boolean indicator set to true if the list should include
FEA/FCAs.

true

tfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.reroute

Required

Boolean indicator set to true if the list should include
reroutes.

false

generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.afp

Required

Boolean indicator set to true if the list should include
AFPs.

false

generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.gdp

Required

Boolean indicator set to true if the list should include
GDPs.

false

generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.gs

Required

Boolean indicator set to true if the list should include
Ground Stops.

false

generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.compression

Required

Boolean indicator set to true if the list should include Flight/Slot
Compressions.

false

generaltfmDataService.tfmRequestReply.request.tmiResyncRequest.requestTmiList.blanket

Required

Boolean indicator set to true if the list should include
Blanket Delays.

false

TFM Data Service TMI List Reply

In response to a valid TMI List request, the requestor will receive one reply containing a list of the types of TMIs requested.

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 a TMI List Request reply.

Schema Element	Required/ Optional	Description	Sample Value
tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi lastUpdateTime	Required	The last time the TMI definition was updated.	2016-08-24T19:15:58Z
tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiReferenceNumber	Required	The TMI reference number to be used in a TMI Resync Request for the actual TMI definition.	500101
tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiType	Required	The type of TMI.	CTOP
tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiName	Required	The long name of TMI.	CTPNE1
tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiId	Optional	The short name of TMI.	CTP002

Schema Element

Required/ Optional

Description

Sample Value

tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi lastUpdateTime

Required

The last time the TMI definition was updated.

2016-08-24T19:15:58Z

tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiReferenceNumber

Required

The TMI reference number to be used in a TMI Resync Request for the actual TMI definition.

500101

tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiType

Required

The type of TMI.

CTOP

tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiName

Required

The long name of TMI.

CTPNE1

tfmDataService.tfmRequestReply.reply.tmiReplyData.tmiIndex.tmi.tmiId

Optional

The short name of TMI.

CTP002

Sample TFM Data Service TMI List Request/Reply

The following is an example of a TFMDdata TMI List request for all types of TMIs currently in TFMS and the reply indicates there is currently a GDP, a GS, 2 FCAs, and an AFP in the system.

<?xml version="1.0" encoding="UTF-8"?>
<tfmDataService xmlns="urn:us:gov:dot:faa:atm:tfm:tfmdataservice" 
xmlns:nas="http://www.faa.aero/nas/3.1" 
xmlns:ax="http://www.fixm.aero/tfm/3.1" xmlns:fb="http://www.fixm.aero/base/3.0" 
xmlns:fx="http://www.fixm.aero/flight/3.0" xmlns:fdm="urn:us:gov:dot:faa:atm:tfm:flightdata" 
xmlns:frt="urn:us:gov:dot:faa:atm:tfm:rapttimeline" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:fim="urn:us:gov:dot:faa:atm:tfm:flowinformation" xmlns:fce="urn:us:gov:dot:faa:atm:tfm:ficommondatatypes" 
xmlns:fcm="urn:us:gov:dot:faa:atm:tfm:ficommonmessages" xmlns:fm2="urn:us:gov:dot:faa:atm:tfm:ficommonmessages2" 
xmlns:nxce="urn:us:gov:dot:faa:atm:tfm:tfmdatacoreelements" xmlns:trr="urn:us:gov:dot:faa:atm:tfm:tfmrequestreplytypes" 
xmlns:nxcm="urn:us:gov:dot:faa:atm:tfm:flightdatacommonmessages" xsi:schemaLocation="urn:us:gov:dot:faa:atm:tfm:tfmdataservice TFMData_Service.xsd">
  <tfmRequestReply>
    <request serviceCode="TMILIST">
      <trr:requestId>
        <trr:requestor>
          <fm2:center>AAL</fm2:center>
          <fm2:requestorId>lxstn01</fm2:requestorId>
        </trr:requestor>
        <trr:uniqueMsgId>4cc58ccf-8d75-4509-9af4-cab7ceca0002</trr:uniqueMsgId>
      </trr:requestId>
      <trr:tmiResyncRequest>
        <trr:requestTmiList>
          <trr:ctop>true</trr:ctop>
          <trr:fxa>true</trr:fxa>
          <trr:reroute>true</trr:reroute>
          <trr:afp>true</trr:afp>
          <trr:gdp>true</trr:gdp>
          <trr:gs>true</trr:gs>
          <trr:compression>true</trr:compression>
          <trr:blanket>true</trr:blanket>
        </trr:requestTmiList>
      </trr:tmiResyncRequest>
    </request>
  </tfmRequestReply>
</tfmDataService>

****************************** Response Returned ****************************
<?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 serviceCode="TMILIST">
            <ns9:requestId>
                <ns9:requestor>
                    <ns8:center>AAL</ns8:center>
                    <ns8:requestorId>lxstn01</ns8:requestorId>
                </ns9:requestor>
                <ns9:uniqueMsgId>4cc58ccf-8d75-4509-9af4-cab7ceca0002</ns9:uniqueMsgId>
            </ns9:requestId>
            <ns9:status>SUCCESS</ns9:status>
            <ns9:tmiReplyData>
                <ns9:tmiIndex>
                    <ns9:tmi lastUpdateTime="2016-08-24T19:15:58Z">
                        <ns8:tmiReferenceNumber>500101</ns8:tmiReferenceNumber>
                        <ns8:tmiType>GS</ns8:tmiType>
                        <ns8:tmiName>ORD</ns8:tmiName>
                        <ns8:tmiId>ORD</ns8:tmiId>
                    </ns9:tmi>
                    <ns9:tmi lastUpdateTime="2016-08-24T19:23:34Z">
                        <ns8:tmiReferenceNumber>202</ns8:tmiReferenceNumber>
                        <ns8:tmiType>AFP</ns8:tmiType>
                        <ns8:tmiName>FCA001</ns8:tmiName>
                        <ns8:tmiId>FCA001</ns8:tmiId>
                    </ns9:tmi>
                    <ns9:tmi lastUpdateTime="2016-08-24T18:55:55Z">
                        <ns8:tmiReferenceNumber>500001</ns8:tmiReferenceNumber>
                        <ns8:tmiType>GDP</ns8:tmiType>
                        <ns8:tmiName>ATL</ns8:tmiName>
                        <ns8:tmiId>ATL</ns8:tmiId>
                    </ns9:tmi>
                    <ns9:tmi lastUpdateTime="2016-08-24T19:19:29Z">
                        <ns8:tmiReferenceNumber>4000003</ns8:tmiReferenceNumber>
                        <ns8:tmiType>FXA</ns8:tmiType>
                        <ns8:tmiName>FCA001</ns8:tmiName>
                        <ns8:tmiId>FCA001</ns8:tmiId>
                    </ns9:tmi>
                    <ns9:tmi lastUpdateTime="2016-08-24T19:04:42Z">
                        <ns8:tmiReferenceNumber>4500001</ns8:tmiReferenceNumber>
                        <ns8:tmiType>FXA</ns8:tmiType>
                        <ns8:tmiName>FCA002</ns8:tmiName>
                        <ns8:tmiId>FCA002</ns8:tmiId>
                    </ns9:tmi>
                </ns9:tmiIndex>
            </ns9:tmiReplyData>
        </ns4:reply>
    </ns4:tfmRequestReply>
</ns4:tfmDataService>

Sample Errors and Warnings

TFMS generates an error if a TMI List Request is received with no TMI type selected. The following is an example of a TFMDdata service request where no TMI type is specified and the error response returned.

<?xml version="1.0" encoding="UTF-8"?>
<tfmDataService xmlns="urn:us:gov:dot:faa:atm:tfm:tfmdataservice" 
xmlns:nas="http://www.faa.aero/nas/3.1" 
xmlns:ax="http://www.fixm.aero/tfm/3.1" xmlns:fb="http://www.fixm.aero/base/3.0" 
xmlns:fx="http://www.fixm.aero/flight/3.0" xmlns:fdm="urn:us:gov:dot:faa:atm:tfm:flightdata" 
xmlns:frt="urn:us:gov:dot:faa:atm:tfm:rapttimeline" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:fim="urn:us:gov:dot:faa:atm:tfm:flowinformation" xmlns:fce="urn:us:gov:dot:faa:atm:tfm:ficommondatatypes" 
xmlns:fcm="urn:us:gov:dot:faa:atm:tfm:ficommonmessages" xmlns:fm2="urn:us:gov:dot:faa:atm:tfm:ficommonmessages2" 
xmlns:nxce="urn:us:gov:dot:faa:atm:tfm:tfmdatacoreelements" xmlns:trr="urn:us:gov:dot:faa:atm:tfm:tfmrequestreplytypes" 
xmlns:nxcm="urn:us:gov:dot:faa:atm:tfm:flightdatacommonmessages" xsi:schemaLocation="urn:us:gov:dot:faa:atm:tfm:tfmdataservice TFMData_Service.xsd">
  <tfmRequestReply>
    <request serviceCode="TMILIST">
      <trr:requestId>
        <trr:requestor>
          <fm2:center>AAL</fm2:center>
          <fm2:requestorId>lxstn01</fm2:requestorId>
        </trr:requestor>
        <trr:uniqueMsgId>4cc58ccf-8d75-4509-9af4-cab7ceca0002</trr:uniqueMsgId>
      </trr:requestId>
      <trr:tmiResyncRequest>
        <trr:requestTmiList>
          <trr:ctop>false</trr:ctop>
          <trr:fxa>false</trr:fxa>
          <trr:reroute>false</trr:reroute>
          <trr:afp>false</trr:afp>
          <trr:gdp>false</trr:gdp>
          <trr:gs>false</trr:gs>
          <trr:compression>false</trr:compression>
          <trr:blanket>false</trr:blanket>
        </trr:requestTmiList>
      </trr:tmiResyncRequest>
    </request>
  </tfmRequestReply>
</tfmDataService>

****************************** Response Returned ****************************

<?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 serviceCode="TMILIST">
            <ns9:requestId>
                <ns9:requestor>
                    <ns8:center>AAL</ns8:center>
                    <ns8:requestorId>lxstn01</ns8:requestorId>
                </ns9:requestor>
                <ns9:uniqueMsgId>4cc58ccf-8d75-4509-9af4-cab7ceca0002</ns9:uniqueMsgId>
            </ns9:requestId>
            <ns9:status>WARNING</ns9:status>
            <ns9:responseMessage>
                <ns9:description>Request contained no program types to include in TMI List Resync response.  Request will not be processed.</ns9:description>
            </ns9:responseMessage>
        </ns4:reply>
    </ns4:tfmRequestReply>
</ns4:tfmDataService>

TFMS generates a warning if a TMI List Request is received for a specific type of TMI and no TMIs of that type are currently in TFMS. The following is an example of a TFMDdata service request where only GDPs were requested, however there were no GDPs in TFMS at the time of the request.

<tfmDataService xmlns="urn:us:gov:dot:faa:atm:tfm:tfmdataservice" 
xmlns:nas="http://www.faa.aero/nas/3.1" 
xmlns:ax="http://www.fixm.aero/tfm/3.1" xmlns:fb="http://www.fixm.aero/base/3.0" 
xmlns:fx="http://www.fixm.aero/flight/3.0" xmlns:fdm="urn:us:gov:dot:faa:atm:tfm:flightdata" 
xmlns:frt="urn:us:gov:dot:faa:atm:tfm:rapttimeline" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:fim="urn:us:gov:dot:faa:atm:tfm:flowinformation" xmlns:fce="urn:us:gov:dot:faa:atm:tfm:ficommondatatypes" 
xmlns:fcm="urn:us:gov:dot:faa:atm:tfm:ficommonmessages" xmlns:fm2="urn:us:gov:dot:faa:atm:tfm:ficommonmessages2" 
xmlns:nxce="urn:us:gov:dot:faa:atm:tfm:tfmdatacoreelements" xmlns:trr="urn:us:gov:dot:faa:atm:tfm:tfmrequestreplytypes" 
xmlns:nxcm="urn:us:gov:dot:faa:atm:tfm:flightdatacommonmessages" xsi:schemaLocation="urn:us:gov:dot:faa:atm:tfm:tfmdataservice TFMData_Service.xsd">
  <tfmRequestReply>
    <request serviceCode="TMILIST">
      <trr:requestId>
        <trr:requestor>
          <fm2:center>AAL</fm2:center>
          <fm2:requestorId>lxstn01</fm2:requestorId>
        </trr:requestor>
        <trr:uniqueMsgId>4cc58ccf-8d75-4509-9af4-cab7ceca0004</trr:uniqueMsgId>
        <trr:replyOption>SUCC_OR_ERR_OR_WARN</trr:replyOption>
      </trr:requestId>
      <trr:tmiResyncRequest>
        <trr:requestTmiList>
          <trr:ctop>false</trr:ctop>
          <trr:fxa>false</trr:fxa>
          <trr:reroute>false</trr:reroute>
          <trr:afp>false</trr:afp>
         <trr:gdp>true</trr:gdp>
          <trr:gs>false</trr:gs>
          <trr:compression>false</trr:compression>
          <trr:blanket>false</trr:blanket>
        </trr:requestTmiList>
      </trr:tmiResyncRequest>
    </request>
  </tfmRequestReply>
</tfmDataService>


****************************** Response Returned ****************************
<?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 serviceCode="TMILIST">
            <ns9:requestId>
                <ns9:requestor>
                    <ns8:center>AAL</ns8:center>
                    <ns8:requestorId>lxstn01</ns8:requestorId>
                </ns9:requestor>
                <ns9:uniqueMsgId>4cc58ccf-8d75-4509-9af4-cab7ceca0004</ns9:uniqueMsgId>
            </ns9:requestId>
            <ns9:status>WARNING</ns9:status>
            <ns9:responseMessage>
                <ns9:description>There are no TMIs to include in the TMI Resync List request.</ns9:description>
            </ns9:responseMessage>
        </ns4:reply>
    </ns4:tfmRequestReply>
</ns4:tfmDataService>