Difference between revisions of "FAADC Atom Feed Specifications V 1.0"

From FPDS-NG

(Created page with " __NOEDITSECTION__ ==Introduction== FAADC has data reporting web services that provide access in real-time to FPDS' central data repository. Atom Feeds provides access to the...")
 
(No difference)

Latest revision as of 14:44, 13 April 2021


Introduction

FAADC has data reporting web services that provide access in real-time to FPDS' central data repository. Atom Feeds provides access to the same data with real time feeds.

NOTE: Below are some examples of the Atom Feed specifications. Please note that the Atom Feed specifications are only a subset of the complete XML schema. Refer to the following URL for the complete schema: https://www.fpds.gov/fpdsng_cms/index.php/worksite

FAADC Atom feed format

FAADC Atom feed specification is based on the industry standard Atom 1.0 format RFC4287 as defined by Internet Engineering Task Force (IETF) in December 2005.

FAADC Assistance data will follow FAADC Version 1.0 Assistance specifications.

Feed XML specification

Example
Atom 1.0 format specification RFC4287 will give the entire description and definition of all the elements used in the specification.

Feed format specification
<feed xmlns="http://www.w3.org/2005/Atom">
	<title>FAADC matching assistance records for the search query : <![CDATA[: recovery]]></title>
	<link rel="alternate" type="text/html" href="url_link"/>
	<link rel="first" type="text/html" href="url_link"/>
	<link rel="last" type="text/html" href="url_link"/>
	<link rel="previous" type="text/html" href="url_link"/>
	<link rel="next" type="text/html" href="url_link"/>
	<modified/>
	<author>
		<name/>
	</author>
	<entry>
		<title><![CDATA[Entry Title]]></title>
		<link rel="alternate" type="text/html" href="url_link"/>
		<modified>2009-08-08 00:33:48</modified>
		<content xmlns:ns1="https://www.fpds.gov" type="application/xml"> 
			... Assistance XML
		</content>
	</entry>
</feed>

Contents

Atom Element Definitions

Container Elements

  • “feed” Element – It is the top-level element of an Atom Feed Document, acting as a container for metadata and data associated with the feed
  • “entry” Element – It represents an individual entry, acting as a container for metadata and data associated with the entry.
  • “content” Element – It contains either links or content of the entry. The “type” attribute specifies the MIME media type. It “type” attribute is not present then the content is treated as “text”. The content of the element is either an Award/IDV xml.

Metadata Elements

  • "author” Element – It indicates the author or the entry or the feed.
  • “link” Element – It defines a reference from an entry or feed to a web resource. The “type” attribute is n advisory media type. It is a hint about the the type of representation that is expected to be returned when the value of href attribute is deferenced. The “rel” attribute indicates the link relation type.
  • “alternate” signifies an alternate version of the resource described by the containing element.
  • “first” signifies the first entry element in the feed.
  • “last” signifies the last entry element in the feed.
  • “previous” signifies the previously read entry element of the feed.
  • “next” signifies the next available entry elements of the feed.
  • “title” Element - It conveys a human-readable title for an entry or feed.
  • “modified” Element with in the “entry” section represents the last modified date of the entry.

Contents

Assistance XML

Assistance Sample XML 
<assistance xmlns:ns1="https://www.fpds.gov/FPDS">
	<assistanceID>
		<agencyCode name="String" departmentID="String" departmentName="String">String</agencyCode>
		<FAIN>String</FAIN>
		<amendmentNumber>0</amendmentNumber>
	</assistanceID>
	<assistanceDates>
		<actionDate>0000-00-00 00:00:00</actionDate>
		<periodOfPerformanceStartDate>0000-00-00 00:00:00</periodOfPerformanceStartDate>
		<periodOfPerformanceEndDate>0000-00-00 00:00:00</periodOfPerformanceEndDate>
		<fiscalYear>0000</fiscalYear>
	</assistanceDates>
	<assistanceData>
	<assistanceIndicators>
		<businessFundsIndicator description="String">String</businessFundsIndicator>
		<individualRecipientIndicator>String</individualRecipientIndicator>
		<researchAndDevelopmentFundsIndicator>String</researchAndDevelopmentFundsIndicator>
	</assistanceIndicators>
	<assistanceCompetition>
		<competedOpportunity description="String">String</competedOpportunity>
		<numberOfProposalsOrApplications>String</numberOfProposalsOrApplications>
	</assistanceCompetition>
	<actionType description="String">String</actionType>
	<assistanceType description="String">String</assistanceType>
	<assistanceDescription>String</assistanceDescription>
	<recordType description="String">String</recordType>
	<typeOfFundsCode description="String">String</typeOfFundsCode>
	</assistanceData>
	<dollarValues>
		<federalActionObligationAmount>3.1415</federalActionObligationAmount>
		<nonFederalFundingAmount>3.1415</nonFederalFundingAmount>
		<totalFederalAwardValueAmount>3.1415</totalFederalAwardValueAmount>
		<researchDollarValues>
			<researchAndDevelopmentAmount>3.1415</researchAndDevelopmentAmount>
			<fellowshipsAndTraineeshipsAmount>3.1415</fellowshipsAndTraineeshipsAmount>
			<researchAndDevelopmentPlantAmount>3.1415</researchAndDevelopmentPlantAmount>
			<facilitiesAndEquipmentForInstructionAmount>3.1415</facilitiesAndEquipmentForInstructionAmount>
			<generalSupportForScienceAndEngineeringAmount>3.1415</generalSupportForScienceAndEngineeringAmount>
			<otherActivitiesRelatedToScienceAndEngineeringAmount>3.1415</otherActivitiesRelatedToScienceAndEngineeringAmount>
			<allOtherActivitiesNotRelatedToScienceAndEngineeringAmount>3.1415</allOtherActivitiesNotRelatedToScienceAndEngineeringAmount>
		</researchDollarValues>
	</dollarValues>
	<providerInformation>
		<awardingSubTierAgencyCode name="String" departmentID="String" departmentName="String">String</awardingSubTierAgencyCode>
		<awardingOfficeCode>String</awardingOfficeCode>
		<fundingSubTierAgencyCode name="String" departmentID="String" departmentName="String">String</fundingSubTierAgencyCode>
		<fundingOfficeCode name="String">String</fundingOfficeCode>
	</providerInformation>
	<programInformation>
	<CFDANumber>00.000</CFDANumber>
	<CFDAProgramTitle>String</CFDAProgramTitle>
	</programInformation>
	<placeOfPerformance>
		<PPOPCode>String</PPOPCode>
		<PPOPDescription>String</PPOPDescription>
		<PPOPCountryCode>String</PPOPCountryCode>
		<PPOPCountryName>String</PPOPCountryName>
		<PPOPStateName>String</PPOPStateName>
		<PPOPStateISO2Code>String</PPOPStateISO2Code>
		<PPOPCountyName>String</PPOPCountyName>
		<PPOPCountyFIPSCode>String</PPOPCountyFIPSCode>
		<PPOPCityName>String</PPOPCityName>
		<PPOPZIPCode>String</PPOPZIPCode>
		<PPOPCongressionalDistrict>String</PPOPCongressionalDistrict>
	</placeOfPerformance>
	<recipient>
		<recipientDetails>
			<vendorHeader>
				<vendorName>String</vendorName>
				<vendorDoingAsBusinessName>String</vendorDoingAsBusinessName>
				<vendorEnabled>false</vendorEnabled>
			</vendorHeader>
			<vendorSiteDetails>
			<vendorSocioEconomicIndicators>
				<isAlaskanNativeOwnedCorporationOrFirm>false</isAlaskanNativeOwnedCorporationOrFirm>
				<isAmericanIndianOwned>false</isAmericanIndianOwned>
				<isIndianTribe>false</isIndianTribe>
				<isNativeHawaiianOwnedOrganizationOrFirm>false</isNativeHawaiianOwnedOrganizationOrFirm>
				<isTriballyOwnedFirm>false</isTriballyOwnedFirm>
				<isSmallBusiness>false</isSmallBusiness>
				<isVeteranOwned>false</isVeteranOwned>
				<isServiceRelatedDisabledVeteranOwnedBusiness>false</isServiceRelatedDisabledVeteranOwnedBusiness>
				<isWomenOwned>false</isWomenOwned>
				<minorityOwned>
					<isMinorityOwned>false</isMinorityOwned>
					<isSubContinentAsianAmericanOwnedBusiness>false</isSubContinentAsianAmericanOwnedBusiness>
					<isAsianPacificAmericanOwnedBusiness>false</isAsianPacificAmericanOwnedBusiness>
					<isBlackAmericanOwnedBusiness>false</isBlackAmericanOwnedBusiness>
					<isHispanicAmericanOwnedBusiness>false</isHispanicAmericanOwnedBusiness>
					<isNativeAmericanOwnedBusiness>false</isNativeAmericanOwnedBusiness>
					<isOtherMinorityOwned>false</isOtherMinorityOwned>
				</minorityOwned>
				<isVerySmallBusiness>false</isVerySmallBusiness>
				<isWomenOwnedSmallBusiness>false</isWomenOwnedSmallBusiness>
				<isEconomicallyDisadvantagedWomenOwnedSmallBusiness>false</isEconomicallyDisadvantagedWomenOwnedSmallBusiness>
				<isJointVentureWomenOwnedSmallBusiness>false</isJointVentureWomenOwnedSmallBusiness>
				<isJointVentureEconomicallyDisadvantagedWomenOwnedSmallBusiness>false</isJointVentureEconomicallyDisadvantagedWomenOwnedSmallBusiness>
			</vendorSocioEconomicIndicators>
			<vendorBusinessTypes>
				<isCommunityDevelopedCorporationOwnedFirm>false</isCommunityDevelopedCorporationOwnedFirm>
				<isLaborSurplusAreaFirm>false</isLaborSurplusAreaFirm>
				<federalGovernment>
					<isFederalGovernment>false</isFederalGovernment>
					<isFederallyFundedResearchAndDevelopmentCorp>false</isFederallyFundedResearchAndDevelopmentCorp>
					<isFederalGovernmentAgency>false</isFederalGovernmentAgency>
				</federalGovernment>
				<isStateGovernment>false</isStateGovernment>
				<localGovernment>
					<isLocalGovernment>false</isLocalGovernment>
					<isCityLocalGovernment>false</isCityLocalGovernment>
					<isCountyLocalGovernment>false</isCountyLocalGovernment>
					<isInterMunicipalLocalGovernment>false</isInterMunicipalLocalGovernment>
					<isLocalGovernmentOwned>false</isLocalGovernmentOwned>
					<isMunicipalityLocalGovernment>false</isMunicipalityLocalGovernment>
					<isSchoolDistrictLocalGovernment>false</isSchoolDistrictLocalGovernment>
					<isTownshipLocalGovernment>false</isTownshipLocalGovernment>
				</localGovernment>
				<isTribalGovernment>false</isTribalGovernment>
				<isForeignGovernment>false</isForeignGovernment>
				<businessOrOrganizationType>
				<isCorporateEntityNotTaxExempt>false</isCorporateEntityNotTaxExempt>
				<isCorporateEntityTaxExempt>false</isCorporateEntityTaxExempt>
				<isPartnershipOrLimitedLiabilityPartnership>false</isPartnershipOrLimitedLiabilityPartnership>
				<isSolePropreitorship>false</isSolePropreitorship>
				<isSmallAgriculturalCooperative>false</isSmallAgriculturalCooperative>
				<isInternationalOrganization>false</isInternationalOrganization>
				<isOtherbusinessOrOrganization>false</isOtherbusinessOrOrganization>
				<isUSGovernmentEntity>false</isUSGovernmentEntity>
				</businessOrOrganizationType>
			</vendorBusinessTypes>
			<vendorLineOfBusiness>
				<isArchitectureAndEngineering>false</isArchitectureAndEngineering>
				<isCommunityDevelopmentCorporation>false</isCommunityDevelopmentCorporation>
				<isConstructionFirm>false</isConstructionFirm>
				<isDomesticShelter>false</isDomesticShelter>
				<isEducationalInstitution>false</isEducationalInstitution>
				<isFoundation>false</isFoundation>
				<isHospital>false</isHospital>
				<isManufacturerOfGoods>false</isManufacturerOfGoods>
				<isResearchAndDevelopment>false</isResearchAndDevelopment>
				<isServiceProvider>false</isServiceProvider>
				<isVeterinaryHospital>false</isVeterinaryHospital>
				<isHispanicServicingInstitution>false</isHispanicServicingInstitution>
			</vendorLineOfBusiness>
			<vendorRelationshipWithFederalGovernment>
				<receivesContracts>false</receivesContracts>
				<receivesGrants>false</receivesGrants>
				<receivesContractsAndGrants>false</receivesContractsAndGrants>
			</vendorRelationshipWithFederalGovernment>
			<typeOfGovernmentEntity>
				<isAirportAuthority>false</isAirportAuthority>
				<isCouncilOfGovernments>false</isCouncilOfGovernments>
				<isHousingAuthoritiesPublicOrTribal>false</isHousingAuthoritiesPublicOrTribal>
				<isInterstateEntity>false</isInterstateEntity>
				<isPlanningCommission>false</isPlanningCommission>
				<isPortAuthority>false</isPortAuthority>
				<isTransitAuthority>false</isTransitAuthority>
			</typeOfGovernmentEntity>
			<vendorOrganizationFactors>
			<isSubchapterSCorporation>false</isSubchapterSCorporation>
			<isLimitedLiabilityCorporation>false</isLimitedLiabilityCorporation>
			<isForeignOwnedAndLocated>false</isForeignOwnedAndLocated>
			<profitStructure>
				<isForProfitOrganization>false</isForProfitOrganization>
				<isNonprofitOrganization>false</isNonprofitOrganization>
				<isOtherNotForProfitOrganization>false</isOtherNotForProfitOrganization>
			</profitStructure>
			<isShelteredWorkshop>false</isShelteredWorkshop>
				<organizationalType>String</organizationalType>
				</vendorOrganizationFactors>
			<typeOfEducationalEntity>
				<is1862LandGrantCollege>false</is1862LandGrantCollege>
				<is1890LandGrantCollege>false</is1890LandGrantCollege>
				<is1994LandGrantCollege>false</is1994LandGrantCollege>
				<isHistoricallyBlackCollegeOrUniversity>false</isHistoricallyBlackCollegeOrUniversity>
				<isMinorityInstitution>false</isMinorityInstitution>
				<isPrivateUniversityOrCollege>false</isPrivateUniversityOrCollege>
				<isSchoolOfForestry>false</isSchoolOfForestry>
				<isStateControlledInstitutionofHigherLearning>false</isStateControlledInstitutionofHigherLearning>
				<isTribalCollege>false</isTribalCollege>
				<isVeterinaryCollege>false</isVeterinaryCollege>
				<isAlaskanNativeServicingInstitution>false</isAlaskanNativeServicingInstitution>
				<isNativeHawaiianServicingInstitution>false</isNativeHawaiianServicingInstitution>
			</typeOfEducationalEntity>
			<vendorCertifications>
				<isDOTCertifiedDisadvantagedBusinessEnterprise>false</isDOTCertifiedDisadvantagedBusinessEnterprise>
				<isSelfCertifiedSmallDisadvantagedBusiness>false</isSelfCertifiedSmallDisadvantagedBusiness>
				<isSBACertifiedSmallDisadvantagedBusiness>false</isSBACertifiedSmallDisadvantagedBusiness>
				<isSBACertified8AProgramParticipant>false</isSBACertified8AProgramParticipant>
				<isSelfCertifiedHUBZoneJointVenture>false</isSelfCertifiedHUBZoneJointVenture>
				<isSBACertifiedHUBZone>false</isSBACertifiedHUBZone>
				<isSBACertified8AJointVenture>false</isSBACertified8AJointVenture>
			</vendorCertifications>
			<vendorLocation>
				<streetAddress>String</streetAddress>
				<city>String</city>
				<state name="String">String</state>
				<ZIPCode city="String">String</ZIPCode>
				<countryCode name="String">String</countryCode>
				<phoneNo>String</phoneNo>
				<faxNo>String</faxNo>
				<congressionalDistrictCode>String</congressionalDistrictCode>
				<vendorLocationDisabledFlag>false</vendorLocationDisabledFlag>
			</vendorLocation>
			<vendorDUNSInformation>
				<DUNSNumber>String</DUNSNumber>
				<vendorName>String</vendorName>
				<parentDUNSNumber>String</parentDUNSNumber>
				<parentDUNSName>String</parentDUNSName>
				<domesticParentDUNSNumber></domesticParentDUNSNumber>
				<domesticParentDUNSName>String</domesticParentDUNSName>
				<globalParentDUNSNumber>String</globalParentDUNSNumber>
				<globalParentDUNSName>String</globalParentDUNSName>
				<cageCode>String</cageCode>
			</vendorDUNSInformation>
			<ccrRegistrationDetails>
			<registrationDate>0000-00-00 00:00:00</registrationDate>
			<renewalDate>0000-00-00 00:00:00</renewalDate>
			</ccrRegistrationDetails>
			</vendorSiteDetails>
		</recipientDetails>
		<listOfBusinessTypes>
			<businessTypes>
				<BusinessTypesCode>String</BusinessTypesCode>
				<BusinessTypesDescription>String</BusinessTypesDescription>
			</businessTypes>
		</listOfBusinessTypes>
		<smallBusinessIndicator description="String">String</smallBusinessIndicator>
		<SAMException description="String">String</SAMException>
	</recipient>
	<transactionInformation>
		<createdBy>String</createdBy>
		<createdDate>0000-00-00 00:00:00</createdDate>
		<lastModifiedBy>String</lastModifiedBy>
		<lastModifiedDate>0000-00-00 00:00:00</lastModifiedDate>
		<status>String</status>
		<version>String</version>
		<approvedBy>String</approvedBy>
		<approvedDate>0000-00-00 00:00:00</approvedDate>
	</transactionInformation>
</assistance>

Contents

Assistance Deleted XML

Assistance Deleted Sample XML 
<assistance xmlns:ns1="https://www.fpds.gov/FPDS">
	<assistanceID>
		<agencyCode name="String" departmentID="String" departmentName="String">String</agencyCode>
		<URI>String</URI>
	</assistanceID>
	<assistanceDates>
		<actionDate>0000-00-00 00:00:00</actionDate>
		<periodOfPerformanceStartDate>0000-00-00 00:00:00</periodOfPerformanceStartDate>
		<periodOfPerformanceEndDate>0000-00-00 00:00:00</periodOfPerformanceEndDate>
		<fiscalYear>0000</fiscalYear>
		<FABSSentDate>0000-00-00 00:00:00</FABSSentDate>
	</assistanceDates>
	<assistanceData>
		<assistanceIndicators>
			<businessFundsIndicator description="String">String</businessFundsIndicator>
			<correctionDeleteIndicator>String</correctionDeleteIndicator>
			<individualRecipientIndicator>String</individualRecipientIndicator>
		</assistanceIndicators>
		<actionType description="String">String</actionType>
		<assistanceType description="String">String</assistanceType>
		<assistanceDescription>String</assistanceDescription>
		<recordType description="String">String</recordType>
	</assistanceData>
	<dollarValues>
		<federalActionObligationAmount>3.1415</federalActionObligationAmount>
		<nonFederalFundingAmount>3.1415</nonFederalFundingAmount>
		<totalFederalAwardValueAmount>3.1415</totalFederalAwardValueAmount>
	</dollarValues>
	<providerInformation>
		<awardingSubTierAgencyCode name="String" departmentID="String" departmentName="String">String</awardingSubTierAgencyCode>
		<awardingOfficeCode name="String">String</awardingOfficeCode>
		<fundingSubTierAgencyCode name="String" departmentID="String" departmentName="String">String</fundingSubTierAgencyCode>
		<fundingOfficeCode name="String">String</fundingOfficeCode>
	</providerInformation>
	<programInformation>
		<CFDANumber>3.1415</CFDANumber>
	</programInformation>
	<placeOfPerformance>
		<PPOPCode>String</PPOPCode>
		<PPOPDescription>String</PPOPDescription>
		<PPOPCountryCode>String</PPOPCountryCode>
		<PPOPCountryName>String</PPOPCountryName>
		<PPOPStateName>String</PPOPStateName>
		<PPOPStateISO2Code>String</PPOPStateISO2Code>
	</placeOfPerformance>
	<recipient>
		<recipientDetails>
		<vendorHeader>
			<vendorName>String</vendorName>
		</vendorHeader>
			<vendorSiteDetails>
				<vendorLocation>
					<countryCode name="String">String</countryCode>
				</vendorLocation>
				<vendorDUNSInformation>
					<DUNSNumber>String</DUNSNumber>
					<vendorName>String</vendorName>
					<parentDUNSNumber>String</parentDUNSNumber>
					<parentDUNSName>String</parentDUNSName>
					<domesticParentDUNSNumber></domesticParentDUNSNumber>
					<domesticParentDUNSName>String</domesticParentDUNSName>
					<globalParentDUNSNumber>String</globalParentDUNSNumber>
					<globalParentDUNSName>String</globalParentDUNSName>
					<cageCode>String</cageCode>
				</vendorDUNSInformation>
			</vendorSiteDetails>
		</recipientDetails>
		<listOfBusinessTypes>
			<businessTypes>
				<BusinessTypesCode>String</BusinessTypesCode>
				<BusinessTypesDescription>String</BusinessTypesDescription>
			</businessTypes>
		</listOfBusinessTypes>
		<smallBusinessIndicator description="String">String</smallBusinessIndicator>
		<SAMException description="String">String</SAMException>
	</recipient>
	<transactionInformation>
		<createdBy>String</createdBy>
		<createdDate>0000-00-00 00:00:00</createdDate>
		<lastModifiedBy>String</lastModifiedBy>
		<lastModifiedDate>0000-00-00 00:00:00</lastModifiedDate>
		<status>String</status>
		<version>String</version>
		<approvedBy>String</approvedBy>
		<approvedDate>0000-00-00 00:00:00</approvedDate>
	</transactionInformation>
</assistance>
Retrieved from "https://fpds.gov/wiki/index.php?title=FAADC_Atom_Feed_Specifications_V_1.0&oldid=4809"