Get Related Document Details


This service retrieves Opportunity Related Document Folders, Files, and Links for a specific Opportunity.

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 Manage Synopses, Manage Forecasts, or Manage Packages role
• 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
RelatedDocumentDetails Folder and File Details Optional GrantsRelatedDocument_V1.0: RelatedDocumentDetails
ErrorDetails   Optional GrantsCommonElements: ErrorDetails