Get Full Opportunity Details

GetFullOpportunityDetails

This service retrieves Forecast, Synopsis, Package(s), Related Documents, Related Links, and Related Opportunities (excluding draft opportunities) details for the specified Opportunity ID, if there are no validation errors.

Informative status

NOTE: The Return Values used by this web service no longer restrict the Funding Activity Categories to a predefined list in the schema. This provides flexibility to add/disable Funding Activity Category values in the future, as needed. The Funding Activity Category(ies) assigned by the Grantor to the opportunity will be returned even if currently disabled.

Input Parameters

This service requires the following request parameter(s):

Input Parameter Description Required/Optional Business Rules Web Service Schema
OpportunityID Opportunity ID Required
  • Certificate must have at least one of the following roles:
    • Manage Forecasts
    • Manage Synopses
    • Manage Packages
  • Opportunity ID must belong to Agency associated with the certificate or any of its Sub-Agencies
 GrantsCommonElements: OpportunityID

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  
OpportunityElementsDetails Opportunity-level information Optional GrantsOpportunity_V1.0: OpportunityElementsDetails
ForecastDetails Forecast Information Optional GrantsForecastSynopsis: ForecastDetails
SynopsisDetails Synopsis Information Optional GrantsForecastSynopsis: SynopsisDetails
PackageDetails Package Information Optional (May have multiple occurrences) GrantsOpportunity_V1.0: PackageDetails
Related Folder(s)/File(s) Details Related Folder(s)/File(s) Information Optional (May have multiple occurrences) GrantsRelatedDocument: FolderAndFileDetails
Related Link(s) Details Related Link(s) Information Optional (May have multiple occurrences) GrantsRelatedDocument: LinkDetails
Opportunity Relationship(s) Opportunity Relationship(s) Information Optional (May have multiple occurrences) GrantsOpportunity_V1.0: RelatedOpportunityDetails
ErrorDetails Error Information Optional (May have multiple occurrences) GrantsCommonElements: ErrorDetails