Web Content Display

ManageRelatedDocumentFolders

This service adds, updates, and deletes one or more Related Document folders for a specific opportunity.

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
OpportunityID Opportunity ID Required • Certificate must have Manage Synopses role
• At least one of the following actions must be specified: Create Folder, Update Folder, or Delete Folder
• Opportunity ID must belong to Agency associated with the certificate (or any of its Sub-• Agencies if certificate has Manage Agencies role)
• Opportunity must have a Synopsis to have Related Documents
GrantsCommonElements: OpportunityID
CreateFolder Create Folder Optional (Multiple occurrences allowed) • Combination of Folder Type and Folder Name must be unique for the Opportunity GrantsRelatedDocument_V1.0: CreateFolder
UpdateFolder Update Folder Optional (Multiple occurrences allowed) • Combination of Folder Type and Folder Name must be unique for the Opportunity
• Folder ID must belong to specified Opportunity ID
GrantsRelatedDocument_V1.0: UpdateFolder
DeleteFolder Delete Folder Optional (Multiple occurrences allowed) • Folder ID must belong to specified Opportunity ID GrantsRelatedDocument_V1.0: DeleteFolder

Return Values

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

Return Value Comment / Example Required/Optional V2.0 Web Service Schema
CompletionStatus Success, Partial, Fail Required GrantsCommonElements: CompletionStatus
ErrorDetails   Optional GrantsCommonElements: ErrorDetails
CreateFolderResult   Optional (May have multiple occurrences) GrantsRelatedDocument_V1.0: CreateFolderResult
UpdateFolderResult   Optional (May have multiple occurrences) GrantsRelatedDocument_V1.0: UpdateFolderResult
DeleteFolderResult   Optional (May have multiple occurrences) GrantsRelatedDocument_V1.0: DeleteFolderResult