Web Content Display

GrantsOpportunity-V1.0.xsd

The 'Grants Opportunity' schema is a new common schema added to standardize the definition of the common elements.

Web Service Version(s)

  • V2.0

Schema Link

For the Training Environment, this schema is located at:
https://trainingapply.grants.gov/apply/system/schemas/GrantsOpportunity-V1.0.xsd

For the Production Environment, this schema is located at:
https://apply07.grants.gov/apply/system/schemas/GrantsOpportunity-V1.0.xsd

Schema Elements

Element Name / Sub-Element Name Element Type Element Rules Required / Optional
CreateOpportunity Complex    
AgencyCode GrantsCommonElements: AgencyCode   Optional
FundingOpportunityNumber GrantsCommonElements: FundingOpportunityNumber   Required
FundingOpportunityTitle GrantsCommonElements: FundingOpportunityTitle   Required
OpportunityCategory GrantsCommonElements: OpportunityCategory   Required
OpportunityCategoryExplanation GrantsCommonElements: OpportunityCategoryExplanation   Optional
CFDANumber GrantsCommonElements: CFDANumber   Required (Multiple occurrences allowed)
UpdateOpportunity Complex    
OpportunityID GrantsCommonElements: OpportunityID   Required
FundingOpportunityNumber GrantsCommonElements: FundingOpportunityNumber   Optional
FundingOpportunityTitle GrantsCommonElements: FundingOpportunityTitle   Optional
OpportunityCategory GrantsCommonElements: OpportunityCategory   Optional
OpportunityCategoryExplanation GrantsCommonElements: OpportunityCategoryExplanation   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional (Multiple occurrences allowed)
SendUpdateNotificationEmail GrantsCommonElements: SendUpdateNotificationEmail Default: Y Optional
UpdateComments GrantsCommonElements: UpdateComments   Required
ElementFilter Complex    
Type GrantsOpportunity: ElementType   Required
Value GrantsCommonTypes: StringMin1Max255Type   Required
DateRangeFilter Complex    
Type GrantsOpportunity: ElementDateType   Required
BeginValue GrantsCommonTypes: MMDDYYYYFwdSlashType   Optional
EndValue GrantsCommonTypes: MMDDYYYYFwdSlashType   Optional
MultiDateRangeFilter Complex    
DateRangeFilter GrantsOpportunity: DateRangeFilter   Required (Up to 7)
ContainsForecast GrantsCommonTypes: YesNoType    
ContainsSynopsis GrantsCommonTypes: YesNoType    
ContainsRelatedDocuments GrantsCommonTypes: YesNoType    
ContainsPackages GrantsCommonTypes: YesNoType    
IncludeDeletedOpportunities GrantsCommonTypes: YesNoType Default: N  
IncludeSubAgencies GrantsCommonTypes: YesNoType Default: Y  
DeleteTimestamp dateTime    
OppFctSynLastUpdatedTimestamp dateTime    
PackagesLastUpdatedTimestamp dateTime    
RelatedDocumentsLastUpdatedTimestamp dateTime    
ElementDateType String

Valid values:
ForecastPostDate
ForecastArchiveDate
SynopsisPostDate
SynopsisCloseDate
SynopsisArchiveDate
PackageOpenDate
PackageCloseDate

 
ElementType String Valid values:
FundingOpportunityNumber
AgencyCode
CFDANumber
 
OpportunityElementsDetails Complex    
AgencyCode GrantsCommonElements: AgencyCode   Optional
AgencyName GrantsCommonElements: AgencyName   Optional
OpportunityID GrantsCommonElements: OpportunityID   Optional
FundingOpportunityNumber GrantsCommonElements: FundingOpportunityNumber   Optional
FundingOpportunityTitle GrantsCommonElements: FundingOpportunityTitle   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional (Multiple occurrences allowed)
OpportunityCategory GrantsCommonElements: OpportunityCategory   Optional
OpportunityCategoryExplanation GrantsCommonElements: OpportunityCategoryExplanation   Optional
LastUpdatedTimestamp GrantsCommonElements: LastUpdatedTimestamp   Optional
OpportunityDetails Complex    
OpportunityElementsDetails GrantsOpportunity: OpportunityElementsDetails   Optional
SynopsisDetails GrantsForecastSynopsis: SynopsisDetails   Optional
ForecastDetails GrantsForecastSynopsis: ForecastDetails   Optional
OpportunitySummary Complex    
OpportunityID GrantsCommonElements: OpportunityID   Optional
FundingOpportunityNumber GrantsCommonElements: FundingOpportunityNumber   Optional
AgencyCode GrantsCommonElements: AgencyCode   Optional
AgencyName GrantsCommonElements: AgencyName   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional (Multiple occurrences allowed)
OppFctSynLastUpdatedTimestamp GrantsOpportunity: OppFctSynLastUpdatedTimestamp   Optional
RelatedDocumentsLastUpdatedTimestamp GrantsOpportunity: RelatedDocumentsLastUpdatedTimestamp   Optional
PackagesLastUpdatedTimestamp GrantsOpportunity: PackagesLastUpdatedTimestamp   Optional
ContainsForecast GrantsOpportunity: ContainsForecast   Optional
ContainsSynopsis GrantsOpportunity: ContainsSynopsis   Optional
ContainsRelatedDocuments GrantsOpportunity: ContainsRelatedDocuments   Optional
ContainsPackages GrantsOpportunity: ContainsPackages   Optional
DeletedOpportunitySummary Complex    
OpportunityID GrantsCommonElements: OpportunityID   Optional
DeleteTimestamp GrantsOpportunity: DeleteTimestamp   Optional