Difference between revisions of "ATOM Feed FAQ"

From FPDS-NG
 
(16 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
=Where can I find all the data elements in the atom feed?=
 
=Where can I find all the data elements in the atom feed?=
  
−
Here are the URLs that show the data elements in the data feed for different versions.  
+
Below are URLs that display the data elements within sample data feeds for different versions.  
  
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.4
+
<h3><u>FPDS</u></h3>
 +
<h5 style="color:blue;">
 +
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.5.2<br>
 +
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.5.3</h5>
  
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.4.1
+
<FONT COLOR="#ff0000"><b><u>Note</u>: As of V1.5 FPDS Service Pack 17, the FPDS V1.5.2 Public (Civilian) and DoD Authenticated Atom Feeds have been deprecated.</b>
 +
</FONT>
  
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.4.2
+
<h3><u>FAADC</u></h3>
 +
<h5 style="color:blue;">
 +
https://www.fpds.gov/wiki/index.php/FAADC_Atom_Feed_Specifications_V_1.1<br>
 +
https://www.fpds.gov/wiki/index.php/FAADC_Atom_Feed_Specifications_V_1.2</h5>
  
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.4.3
+
<FONT COLOR="#ff0000"><b><u>Note</u>: As of V1.5 FPDS Service Pack 13, the FAADC V1.0 Assistance and Assistance Deleted Atom Feeds have been deprecated.</b></FONT>
−
 
+
<br>
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.4.4
+
<FONT COLOR="#ff0000"><b><u>Note</u>: As of FAADC Version Change 1.2, the FAADC V1.1 Assistance and Assistance Deleted Atom Feeds have been deprecated.</b></FONT>
−
 
 
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.4.5
 
−
 
 
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.5.0
 
−
 
 
−
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.5.1
 
  
 
=How do we fetch deleted contracts?=
 
=How do we fetch deleted contracts?=
−
The URL below will fetch the deleted contracts.
+
The URL below will fetch deleted FPDS contract action reports.
  
 
https://www.fpds.gov/ezsearch/FEEDS/ATOM?FEEDNAME=DELETED&q=
 
https://www.fpds.gov/ezsearch/FEEDS/ATOM?FEEDNAME=DELETED&q=
Line 37: Line 38:
  
 
=Do I need an FPDS account to use atom feed?=
 
=Do I need an FPDS account to use atom feed?=
−
The atom feed is for public use so no account is required. If you are a DOD user please go to www.fsd.gov or call (866) 606-8220.
+
The atom feed is for public use so no account is required. If you are a user that needs access to DoD or FAADC feeds, please go to www.fsd.gov or call (866) 606-8220 to request an Authenticated ATOM Feed account.
  
 
=Atom feed is updated on a daily basis. What data element should I use to extract the contracts?=
 
=Atom feed is updated on a daily basis. What data element should I use to extract the contracts?=
  
−
Use the last modified date, different search criteria is available in the URL below with examples
+
Use the 'Last Modified Date' filter. For the Public and DoD feeds, different search criteria is available with examples in the URL below:
  
 
https://www.fpds.gov/wiki/index.php/Atom_Feed_Usage
 
https://www.fpds.gov/wiki/index.php/Atom_Feed_Usage
Line 47: Line 48:
 
=What are the basic differences between the Atom Feed versions?=
 
=What are the basic differences between the Atom Feed versions?=
  
−
V 1.4 - The initial version of the Atom Feed with the XML samples for Award, IDV, OT Award and OT Agreement are provided.
+
<FONT COLOR="#ff0000"><b><u>Announcement</u>:</b></FONT>
 +
As of V1.5 FPDS Service Pack 13, UEI (DUNS)-related tags have been removed from Atom Feed View. Both the FPDS V1.5.2 Atom Feeds and FAADC V1.1 Atom Feeds will no longer return the tags listed below.
 +
 
 +
<b>Vendor section</b>
 +
- Unique Entity ID (DUNS): <DUNSNumber>, <vendorSiteCode>
 +
- UEI (DUNS) Legal Business Name: <vendorName> (*removed from entityIdentifiers section only)
 +
- Immediate Parent UEI (DUNS): <parentDUNSNumber>
 +
- Immediate Parent UEI (DUNS) Name: <parentDUNSName>
 +
- Domestic Parent UEI (DUNS): <domesticParentDUNSNumber>
 +
- Domestic Parent UEI (DUNS) Name: <domesticParentDUNSName>
 +
- Ultimate Parent UEI (DUNS): <globalParentDUNSNumber>
 +
- Ultimate Parent UEI (DUNS) Name: <globalParentDUNSName>
 +
 
 +
<h3><u>FPDS</u></h3>
 +
 
 +
<u>V 1.5.2</u> – Several new fields and updates have been added to the Atom feeds.
 +
 
 +
<ul>
 +
<li>A new 'entityIdentifiers' tag has been created, to display entity UEI information.</li>
 +
<ul>
 +
<li>A new ‘vendorUEIInformation’ tag and associated UEI element tags have been created.</li>
 +
<li>The ‘cageCode’ tag has been moved beneath the ‘vendorUEIInformation’ tag.</li>
 +
</ul>
 +
<li>A new 'entityDataSource' tag has been created.</li>
 +
<li>A generic string tag, ‘genericString02,’ shall be used to populate UEI.</li>
 +
</ul>
 +
 
 +
 
 +
The new fields and corresponding tags are listed for reference below.
 +
 +
<b>Vendor section</b>
 +
- Entity Data Source: <entityDataSource>
 +
- Unique Entity ID: <UEI>
 +
- UEI Legal Business Name: <UEILegalBusinessName>
 +
- Immediate Parent UEI: <immediateParentUEI>
 +
- Immediate Parent UEI Name: <immediateParentUEIName>
 +
- Domestic Parent UEI: <domesticParentUEI>
 +
- Domestic Parent UEI Name: <domesticParentUEIName>
 +
- Ultimate Parent UEI: <ultimateParentUEI>
 +
- Ultimate Parent UEI Name: <ultimateParentUEIName>
 +
 
 +
<b>Generic Tag section</b><br>
 +
- Unique Entity ID: <genericString02>
 +
 
 +
 
 +
<u>V 1.5.3:</u>
 +
<p>Several new fields have been added to include Consortia tags for Other Transaction records only. The Consortia tags are listed for reference below.</p>
 +
 
 +
<b>Consortia Information section</b>
 +
- Primary Consortia Member Name: <primaryConsortiaMemberName>
 +
- Primary Consortia Member Cage Code: <primaryConsortiaMemberCageCode>
 +
 
 +
<b>Primary Consortia Location section (within Consortia Information section)</b>
 +
- street Address 1: <streetAddress1>
 +
- street Address 2: <streetAddress2>
 +
- City: <city>
 +
- State: <state>
 +
- ZIP Code: <ZIPCode>
 +
- Congressional District Code: <congressionalDistrictCode>
 +
- Country Code: <countryCode>
 +
 
 +
<u>August 2023</u> - Four new fields have been added for Awards and IDVs (but not Other Transaction records). The new fields and corresponding tags are listed for reference below.
  
−
V 1.4.1 - Cumulative Dollars Obligated, Base and Exercised Options Value and Base and All Options Value, US Government Entity, Alaskan Native Servicing Institution and Native Hawaiian Servicing Institution have been added.
+
<b>Generic Tag section</b><br>
 +
- Small Business Joint Venture: <genericBoolean01>
 +
- Service-Disabled Veteran-Owned Business Joint Venture: <genericBoolean02>
 +
- SBA-Certified Women-Owned Small Business: <genericBoolean03>
 +
- SBA-Certified Economically Disadvantaged Women-Owned Small Business: <genericBoolean04>
  
−
V 1.4.2 - Women Owned Small Business, Economically Disadvantaged Women Owned Small Business, Joint Venture Women Owned Small Business and Joint Venture Economically Disadvantaged Women Owned Small Business have been added.
+
<h3><u>FAADC</u></h3>
  
−
V 1.4.3 - Department ID and Name have been added in the "contractingOfficeAgencyID" and "fundingRequestingAgencyID" tags, Region Code has been added in the "contractingOfficeID" tag, Part 8 or Part 13 has been added in the "contractActionType" tag and Product or Service Type has been added in the "productOrServiceCode" tag.
+
<u>V 1.1</u> – Several new fields and updates have been added to the FAADC Atom feeds.
  
−
V 1.4.4 - The "inherentlyGovernmentalFunction description" tag has been added in the "Contract Data" section.
+
<ul>
 +
<li>A new “Entity Identifiers” tag has been created, to display entity UEI information.</li>
 +
<ul>
 +
<li>A new ‘vendorUEIInformation’ tag and associated UEI element tags have been created.</li>
 +
<li>The ‘cageCode’ tag has been moved beneath the ‘vendorUEIInformation’ tag.</li>
 +
</ul>
 +
<li>A new 'entityDataSource' tag has been created.</li>
 +
<li>A set of generic tags has been created.</li>
 +
<li>2 generic tags were assigned to new FAADC data elements:</li>
 +
<ul><li>Indirect Cost Federal Share Amount: ‘genericFloat01’</li></ul>
 +
<ul><li>Funding Opportunity Goals Text: ‘genericString01’</li></ul>
 +
<li>August 2023: 4 more generic tags were assigned to new FAADC data elements:</li>
 +
<ul><li>Service-Disabled Veteran-Owned Business Joint Venture: ‘genericString02’</li></ul>
 +
<ul><li>SBA-Certified Women-Owned Small Business: ‘genericString03’</li></ul>
 +
<ul><li>SBA-Certified Economically Disadvantaged Women-Owned Small Business: ‘genericString04’</li></ul>
 +
<ul><li>Small Business Joint Venture: ‘genericString05’</li></ul>
 +
</ul>
  
−
V 1.4.5 – “Approved By” and "Approved Date” tags added in the “Transaction Information” section. “Referenced IDV Type,” “Referenced IDV Multiple or Single,” and “Referenced IDV Part 8 or Part 13” tags added in the “Contract Data” section. "Cage Code" added in the "Vendor DUNS Information" section.
+
The new fields are listed below for reference:
 +
   
 +
<b>Vendor section</b>
 +
- Entity Data Source: <entityDataSource>
 +
- Unique Entity ID: <UEI>
 +
- UEI Legal Business Name: <UEILegalBusinessName>
 +
- Immediate Parent UEI: <immediateParentUEI>
 +
- Immediate Parent UEI Name: <immediateParentUEIName>
 +
- Domestic Parent UEI: <domesticParentUEI>
 +
- Domestic Parent UEI Name: <domesticParentUEIName>
 +
- Ultimate Parent UEI: <ultimateParentUEI>
 +
- Ultimate Parent UEI Name: <ultimateParentUEIName>
  
−
V 1.5.0 - Several new fields have been added to the Atom feeds.
+
<b>Generic Tag section</b><br>
 +
- 18 Generic String tags
 +
- 2 Generic Boolean tags
 +
- 2 Generic Float tags
 +
- 2 Generic Integer tags
  
−
Transaction Information
+
<u>V 1.2</u> – New fields were added to the FAADC Atom feeds or new tags were assigned.
−
- Closed Status
+
<ul><li>New FAADC data elements added:</li>
−
- Closed Date
+
<ul>
−
- Closed By
+
<li>Predominant Assistance Listing: 'isPredominantAL'</li>
−
Legislative Mandates
+
<li>Assistance Listing's Federal Action Obligation: 'ALFederalActionObligationAmount'</li>
−
- Additional Reporting
+
<li>Assistance Listing's Non-Federal Funding Amount: 'ALNonFederalFundingAmount'</li>
−
- The tag "Walsh-Healey Act" has been changed to "Materials, Supplies, Articles, & Equipment"
+
<li>Assistance Listing's Face Value of Direct Loan or Loan Guarantee:
−
- The tag "Service Contract Act" has been changed to "Labor Standards"
+
'ALFaceValueOfDirectLoanOrLoanGuaranteeAmount'</li>
−
- The tag "Davis-Bacon Act" has been changed to "Construction Wage Rate Requirements"
+
<li>Assistance Listing's Original Loan Subsidy Cost: 'ALOriginalLoanSubsidyAmount'</li>
−
Total Dollar Values
+
<li>Assistance Listing's FABS Sent Date: 'ALFABSSentDate'</li>
−
- Total Estimated Order Value
+
<li>Discretionary: ‘discretionary’</li>
−
Competition Information
+
</ul>
−
- IDV Type of Set Aside
+
</ul>
−
- Type of Set Aside Source
+
<ul><li>FAADC data elements assigned new tags:</li>
−
- IDV Number of Offers Received
+
<ul>
−
- Number of Offers Source
+
<li>Assistance Listing Number (formerly CFDA Number): 'ALNumber'</li>
−
NASA Specific Elements
+
<li>Assistance Listing Program Title (formerly CFDA Program Title): 'ALProgramTitle'</li>
−
- CFDA Program Identification Number
+
<li>Assistance Listing's Correction Delete Indicator: 'ALCorrectionDeleteIndicator'</li>
−
- Non-Federal Funding Amount
+
<li>Indirect Cost Federal Share Amount:
−
Contract Marketing Data
+
‘indirectCostFederalShareAmount’</li>
−
- The tag "Maximum Order Limit" has been changed to "Individual Order / Call Limit"
+
<li>Funding Opportunity Goals Text: ‘fundingOpportunityGoalsText’</li>
 +
<li>Service-Disabled Veteran-Owned Business Joint Venture: ‘isJointVentureServiceDisabledVetOwnedBusiness’</li>
 +
<li>SBA-Certified Women-Owned Small Business: ‘isSBACertifiedWomenOwnedSmallBusiness’</li>
 +
<li>SBA-Certified Economically Disadvantaged Women-Owned Small Business: ‘isSBACertifiedEconDisadvWomenOwnedSmallBusiness’</li>
 +
<li>Small Business Joint Venture: ‘isJointVentureSmallBusiness’</li>
 +
</ul>
 +
</ul>
  
−
V 1.5.1 - Country of Contracting Office has been added to the Purchaser Information section.
 
  
−
HUBZone Joint Venture has been added to the Vendor Certifications section.
+
&#42;<u><b>Note</b></u>: Future use of the blank tags will be decided by the executive governance working group. The CWS will have to be certified to ensure that the new generic tags can be sent.

Latest revision as of 15:19, 19 November 2024


You must click here for very important D&B information.

Where can I find all the data elements in the atom feed?

Below are URLs that display the data elements within sample data feeds for different versions.

FPDS

https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.5.2
https://www.fpds.gov/wiki/index.php/Atom_Feed_Specifications_V_1.5.3

Note: As of V1.5 FPDS Service Pack 17, the FPDS V1.5.2 Public (Civilian) and DoD Authenticated Atom Feeds have been deprecated.

FAADC

https://www.fpds.gov/wiki/index.php/FAADC_Atom_Feed_Specifications_V_1.1
https://www.fpds.gov/wiki/index.php/FAADC_Atom_Feed_Specifications_V_1.2

Note: As of V1.5 FPDS Service Pack 13, the FAADC V1.0 Assistance and Assistance Deleted Atom Feeds have been deprecated.
Note: As of FAADC Version Change 1.2, the FAADC V1.1 Assistance and Assistance Deleted Atom Feeds have been deprecated.

How do we fetch deleted contracts?

The URL below will fetch deleted FPDS contract action reports.

https://www.fpds.gov/ezsearch/FEEDS/ATOM?FEEDNAME=DELETED&q=

Would pulling thousands of records at a time be a problem for the atom feed?

Pulling 10K records per search in the limit for Atom Feed would not be feasible. 1 atom feed thread is limited to pull only 10 records per search, however, you can run 10 threads per search, so technically you would be able to pull 100 records per search

What time of day is good to schedule atom feed downloads?

Any time after 9:00 AM eastern time.

Do I need an FPDS account to use atom feed?

The atom feed is for public use so no account is required. If you are a user that needs access to DoD or FAADC feeds, please go to www.fsd.gov or call (866) 606-8220 to request an Authenticated ATOM Feed account.

Atom feed is updated on a daily basis. What data element should I use to extract the contracts?

Use the 'Last Modified Date' filter. For the Public and DoD feeds, different search criteria is available with examples in the URL below:

https://www.fpds.gov/wiki/index.php/Atom_Feed_Usage

What are the basic differences between the Atom Feed versions?

Announcement: As of V1.5 FPDS Service Pack 13, UEI (DUNS)-related tags have been removed from Atom Feed View. Both the FPDS V1.5.2 Atom Feeds and FAADC V1.1 Atom Feeds will no longer return the tags listed below.

Vendor section 

- Unique Entity ID (DUNS): <DUNSNumber>, <vendorSiteCode>
- UEI (DUNS) Legal Business Name: <vendorName> (*removed from entityIdentifiers section only)
- Immediate Parent UEI (DUNS): <parentDUNSNumber>
- Immediate Parent UEI (DUNS) Name: <parentDUNSName>
- Domestic Parent UEI (DUNS): <domesticParentDUNSNumber>
- Domestic Parent UEI (DUNS) Name: <domesticParentDUNSName>
- Ultimate Parent UEI (DUNS): <globalParentDUNSNumber>
- Ultimate Parent UEI (DUNS) Name: <globalParentDUNSName>

FPDS

V 1.5.2 – Several new fields and updates have been added to the Atom feeds.

  • A new 'entityIdentifiers' tag has been created, to display entity UEI information.
    • A new ‘vendorUEIInformation’ tag and associated UEI element tags have been created.
    • The ‘cageCode’ tag has been moved beneath the ‘vendorUEIInformation’ tag.
  • A new 'entityDataSource' tag has been created.
  • A generic string tag, ‘genericString02,’ shall be used to populate UEI.


The new fields and corresponding tags are listed for reference below.

Vendor section 

- Entity Data Source: <entityDataSource>
- Unique Entity ID: <UEI>
- UEI Legal Business Name: <UEILegalBusinessName>
- Immediate Parent UEI: <immediateParentUEI>
- Immediate Parent UEI Name: <immediateParentUEIName>
- Domestic Parent UEI: <domesticParentUEI>
- Domestic Parent UEI Name: <domesticParentUEIName>
- Ultimate Parent UEI: <ultimateParentUEI>
- Ultimate Parent UEI Name: <ultimateParentUEIName>

Generic Tag section

- Unique Entity ID: <genericString02>


V 1.5.3:

Several new fields have been added to include Consortia tags for Other Transaction records only. The Consortia tags are listed for reference below.

Consortia Information section 

- Primary Consortia Member Name: <primaryConsortiaMemberName>
- Primary Consortia Member Cage Code: <primaryConsortiaMemberCageCode>

Primary Consortia Location section (within Consortia Information section) 

- street Address 1: <streetAddress1>
- street Address 2: <streetAddress2>
- City: <city>
- State: <state>
- ZIP Code: <ZIPCode>
- Congressional District Code: <congressionalDistrictCode>
- Country Code: <countryCode>

August 2023 - Four new fields have been added for Awards and IDVs (but not Other Transaction records). The new fields and corresponding tags are listed for reference below.

Generic Tag section

- Small Business Joint Venture: <genericBoolean01>
- Service-Disabled Veteran-Owned Business Joint Venture: <genericBoolean02>
- SBA-Certified Women-Owned Small Business: <genericBoolean03>
- SBA-Certified Economically Disadvantaged Women-Owned Small Business: <genericBoolean04>

FAADC

V 1.1 – Several new fields and updates have been added to the FAADC Atom feeds.

  • A new “Entity Identifiers” tag has been created, to display entity UEI information.
    • A new ‘vendorUEIInformation’ tag and associated UEI element tags have been created.
    • The ‘cageCode’ tag has been moved beneath the ‘vendorUEIInformation’ tag.
  • A new 'entityDataSource' tag has been created.
  • A set of generic tags has been created.
  • 2 generic tags were assigned to new FAADC data elements:
    • Indirect Cost Federal Share Amount: ‘genericFloat01’
    • Funding Opportunity Goals Text: ‘genericString01’
  • August 2023: 4 more generic tags were assigned to new FAADC data elements:
    • Service-Disabled Veteran-Owned Business Joint Venture: ‘genericString02’
    • SBA-Certified Women-Owned Small Business: ‘genericString03’
    • SBA-Certified Economically Disadvantaged Women-Owned Small Business: ‘genericString04’
    • Small Business Joint Venture: ‘genericString05’

The new fields are listed below for reference:

Vendor section 

- Entity Data Source: <entityDataSource>
- Unique Entity ID: <UEI>
- UEI Legal Business Name: <UEILegalBusinessName>
- Immediate Parent UEI: <immediateParentUEI>
- Immediate Parent UEI Name: <immediateParentUEIName>
- Domestic Parent UEI: <domesticParentUEI>
- Domestic Parent UEI Name: <domesticParentUEIName>
- Ultimate Parent UEI: <ultimateParentUEI>
- Ultimate Parent UEI Name: <ultimateParentUEIName>

Generic Tag section

- 18 Generic String tags
- 2 Generic Boolean tags
- 2 Generic Float tags
- 2 Generic Integer tags

V 1.2 – New fields were added to the FAADC Atom feeds or new tags were assigned.

  • New FAADC data elements added:
    • Predominant Assistance Listing: 'isPredominantAL'
    • Assistance Listing's Federal Action Obligation: 'ALFederalActionObligationAmount'
    • Assistance Listing's Non-Federal Funding Amount: 'ALNonFederalFundingAmount'
    • Assistance Listing's Face Value of Direct Loan or Loan Guarantee: 'ALFaceValueOfDirectLoanOrLoanGuaranteeAmount'
    • Assistance Listing's Original Loan Subsidy Cost: 'ALOriginalLoanSubsidyAmount'
    • Assistance Listing's FABS Sent Date: 'ALFABSSentDate'
    • Discretionary: ‘discretionary’
  • FAADC data elements assigned new tags:
    • Assistance Listing Number (formerly CFDA Number): 'ALNumber'
    • Assistance Listing Program Title (formerly CFDA Program Title): 'ALProgramTitle'
    • Assistance Listing's Correction Delete Indicator: 'ALCorrectionDeleteIndicator'
    • Indirect Cost Federal Share Amount: ‘indirectCostFederalShareAmount’
    • Funding Opportunity Goals Text: ‘fundingOpportunityGoalsText’
    • Service-Disabled Veteran-Owned Business Joint Venture: ‘isJointVentureServiceDisabledVetOwnedBusiness’
    • SBA-Certified Women-Owned Small Business: ‘isSBACertifiedWomenOwnedSmallBusiness’
    • SBA-Certified Economically Disadvantaged Women-Owned Small Business: ‘isSBACertifiedEconDisadvWomenOwnedSmallBusiness’
    • Small Business Joint Venture: ‘isJointVentureSmallBusiness’


*Note: Future use of the blank tags will be decided by the executive governance working group. The CWS will have to be certified to ensure that the new generic tags can be sent.

Retrieved from "https://fpds.gov/wiki/index.php?title=ATOM_Feed_FAQ&oldid=5052"