NIEM Examples - International Fuel Tax Association (IFTA) (FQC/FRC)
International Fuel Tax Association (IFTA) NIEM Specifications
This section describes the format and provides examples for IFTA queries and responses. IFTA queries should be sent to destination FT.
All Nlets NIEM messages must be based on the Nlets NIEM Message Structure and include the standard Nlets XML Header as detailed in Message Structure. The NIEM header and hierarchy of the elements in this section have been omitted to avoid redundancy. The associated schemas and instances should be consulted to determine the correct XPaths of the elements.
Element Dictionary
Transaction types detailed below include: IFTA Query by Organization ID (FQC), IFTA Positive Response (FRC) and IFTA Negative (no hit) Response (FRC)
Query Formats
IFTA Query by Organization's IFTA ID (FQC)
Inquiry Data (n2:NLETSInquiryData)
This element will contain all elements specific to this transaction.
Organization (nc:Organization)
GJXDM: Details about a unit which conducts some sort of business or operations.
This element encapsulates the information about the organization.
nc:OrganizationOtherIdentification
This element will contain the Organization IFTA ID.
Organization's IFTA ID (nc:IdentificationID)
GJXDM: A generic identifier assigned to an organization.
This element contains the IFTA ID (typically the same as FEIN) of the organization being queried. The value should be
in the subelement j:ID.
Response Formats
IFTA Positive (hit) Response (FRC)
n2:NLETSResponseData
This element will contain all elements specific to this transaction.
Organization (n2:RevokedCarrierOrganization)
NIEM: Details about a unit which conducts some sort of business or operations.
This element encapsulates the information about the organization.
Organization Name (nc:OrganizationName)
NIEM: A name of an organization.
This element contains the name of the organization.
Organization's IFTA ID (nc:OrganizationOtherIdentification)
NIEM: An alternate identifier assigned to an organization.
This element encapsulates the IFTA ID (typically the same as FEIN) of the organization. The subelement
nc:IdentificationSourceText will be set to "IFTA". The value should be in the subelement nc:IdentificationID.
Organization's DOT Number (nc:OrganizationOtherIdentification)
NIEM: An alternate identifier assigned to an organization.
This element encapsulates the IFTA ID (typically the same as FEIN) of the organization. The subelement
nc:IdentificationSourceText will be set to "DOT". The value should be in the subelement nc:IdentificationID.
Contact Information (nc:OrganizationPrimaryContactInformation)
NIEM: A preferred means of contacting an organization.
This element encapsulates contact information for the organization.
Telephone Number (nc:ContactTelephoneNumber)
NIEM: A telephone number for a telecommunication device by which a person or organization may be contacted.
This element contains the telephone number. The actual value will be in the subelement nc:FullTelephoneNumber.
Organization Doing Business As (nc:OrganizationDoingBusinessAsName)
NIEM: A name an organization uses for conducting business.
This element contains the organization's name for doing business.
Organization Augmentation (j:OrganizationAugmentation)
NIEM: Additional information about an organization.
Organization Jurisdiction (j:OrganizationJurisdiction)
NIEM: An area of service or jurisdiction an organization has over a region.
This element encapsulates information regarding organization's jurisdiction.
Jurisdiction Text (nc:JurisdictionText)
NIEM: An area in which an organization or person has some kind of authoritative capacity or responsibility over.
The organization's jurisdiction.
Organization Status Date (nc:OrganizationStatus)
NIEM: A date a status was set, effected, or reported.
This element will indicate the date upon which the organization's status was changed to revoked. The actual value will be reported in the
nc:StatusDate/nc:Date elements.
IFTA Negative (no hit) Response (FRC)
Response Data (n2:ResponseText)
This element will contain all elements specific to this transaction.
Response Text (n2:NLETSResponseData)
This element will contain the free text driver's license response. Nlets recommends the use of
<![CDATA[]]>
tags to
ensure that the response does not contain any characters illegal in XML.
International Fuel Tax Association (IFTA) NIEM Examples
Example 1: IFTA query by organization.
<n2:NLETS xmlns:n2="http://www.nlets.org/niem/1.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" version="4.00">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>FQC</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>ORIGORI01</nh2:OriginatingORIID>
<nh2:DestinationORIID>DESTORI01</nh2:DestinationORIID>
<nh2:DocumentControlFieldText>FQCNIEM001</nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="FQC">
<n2:InquiryDescriptionText>FQC to FT</n2:InquiryDescriptionText>
<nc:Organization>
<nc:OrganizationOtherIdentification>
<nc:IdentificationID>123456789</nc:IdentificationID>
</nc:OrganizationOtherIdentification>
</nc:Organization>
</n2:NLETSInquiryData>
</n2:NLETS>
Example 2: IFTA positive response.
<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>FRC</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>FT0000000</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS45</nh2:DestinationORIID>
<nh2:MessageReceiveDate>01/01/2010</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>13:00</nh2:MessageReceiveTime>
<nh2:MessageSendDate>01/01/2010</nh2:MessageSendDate>
<nh2:MessageSendTime>13:00</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>01232</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>71236</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSResponseData n2:key="FRC">
<n2:ResponseText>
<![CDATA[IFTA NUMBER: AZ22590687501
ORGANIZATION NAME: JOHN SMITH
DOING BUSINESS AS NAME: JOHN TRUCKING
JURISDICTION: AZ
CONTACT NUMBER: (602) 555-1234
STATUS: REVOKED AS OF 20100101]]>
</n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>
Example 3: IFTA Negative (no hit) response.
<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>FRC</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>FT0000000</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS45</nh2:DestinationORIID>
<nh2:MessageReceiveDate>01/01/2010</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>13:00</nh2:MessageReceiveTime>
<nh2:MessageSendDate>01/01/2010</nh2:MessageSendDate>
<nh2:MessageSendTime>13:00</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>01232</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>71236</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSResponseData n2:key="FRC">
<n2:ResponseText>
No record found. Please note that the IFTA, Inc database returns only revoked vehicles
</n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>