GetOpportunityList

This service retrieves list of Opportunities based on filter criteria.

Input Parameters

This service requires the following request parameter(s):

Input Parameter Description Required/Optional Business Rules Web Service Schema
Opportunity Filter Filter can include Funding Opportunity Number, Agency Code, CFDA Number(s), Forecast Post Date Range, Forecast Archive Date Range, Synopsis Post Date Range, Synopsis Close Date Range, Synopsis Archive Date Range, Package Open Date Range, Package Close Date Range, and Last Updated Timestamp Range Optional (Multiple Occurrences Allowed) Certificate must have at least one of the following roles:
  • Manage Forecasts
  • Manage Synopses
  • Manage Packages
 GrantsOpportunity_V1.0: ElementFilter
IncludeDeletedOpportunities Include Deleted Opportunities (Y, N) Optional Default: N
  • When flag is "Y", return list of Deleted Opportunities based on Sub Agencies flag and matching Opportunity Element(s) and Last Updated Date/Time filters
 GrantsOpportunity_V1.0: IncludeDeletedOpportunities
IncludeSubAgencies Include Sub Agencies (Y, N) Optional

Default: Y

  • When flag is "Y", return Opportunities for Certificate Agency and its Sub Agencies matching filter criteria
  • When flag is "N", return Opportunities for Certificate Agency matching filter criteria
 GrantsOpportunity_V1.0: IncludeSubAgencies

Return Values

This service returns a collection of objects containing the following details:

Return Value Comment / Example Required/Optional Web Service Schema
Success True, False Required  
OpportunitySummary   Optional (May have multiple occurrences) GrantsOpportunity_V1.0: OpportunitySummary
DeletedOpportunitySummary   Optional (May have multiple occurrences) GrantsOpportunity_V1.0: DeletedOpportunitySummary
ErrorDetails   Optional (May have multiple occurrences) GrantsCommonElements: ErrorDetails