Web Content Display

GetOpportunityList

This service retrieves list of Opportunities based on filter criteria.

Web Service Version(s)

  • V2.0

Input Parameters

This service requires the following request parameter(s):

Input Parameter Description Required/Optional Business Rules V2.0 Web Service Schema
ElementFilter Element Filter Optional (Multiple Occurrences Allowed) Certificate must have at least one of the following roles:
·Manage Forecasts
·Manage Synopses
·Manage Packages
GrantsOpportunity_V1.0: ElementFilter
LastUpdatedTimestampRangeFilter Last Updated Timestamp Range Filter Optional   GrantsCommonElements: LastUpdatedTimestampRangeFilter
MultiDateRangeFilter Multi Date Range Filter Optional   GrantsOpportunity_V1.0: MultiDateRangeFilter
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
ElementFilter-Value-Uniqueness
ElementFilter
Value
      GrantsOpportunity_V1.0
MultiDateRangeFilter-DateRangeFilter-Type-Uniqueness
DateRangeFilter
Type
      GrantsOpportunity_V1.0

Return Values

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

Return Value Comment / Example Required/Optional V2.0 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