Manage Related Document Files
- Applicant System-to-System
-
Grantor System-to-System
- Versions & WSDLs
-
Web Services
- Confirm Application Delivery
- Create Adobe Opportunity
- Create Opportunity Forecast
- Create Opportunity Package
- Create Template
- Delete Adobe Opportunity
- Delete Adobe Synopsis
- Delete Opportunity Forecast
- Delete Opportunity Package
- Delete Template
- Get Application
- Get Application List Expanded
- Get Application Zip
- Get Forecast and Synopsis Details
- Get Forms
- Get Full Opportunity Details
- Get Opportunity List
- Get Package Details
- Get Related Document Details
- Get Related Opportunities
- Get Submission List
- Get Submission List Expanded
- Get Templates
- Manage Related Document Files
- Manage Related Document Folders
- Manage Related Document Links
- Manage Related Opportunities
- Update Adobe Opportunity
- Update Application Info
- Update Opportunity Elements
- Update Opportunity Forecast
- Update Opportunity Package
- Update Template
- Schemas
- Certificates
- Testing
- Reference Implementation
- Listserv
- Troubleshooting
- RESTful APIs
ManageRelatedDocumentFiles
This service adds, updates, and deletes one or more Related Document files within specified folders 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 • At least one of the following actions must be specified: Add File, Replace File, or Remove File • 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, Forecast or Package to have Related Documents • Attachment file cannot contain viruses |
GrantsCommonElements: OpportunityID |
| ModificationComments | Modification Comments | Optional |
• If modification comments are specified, Opportunity will be included in the nightly email notification |
GrantsCommonElements: ModificationComments |
| AddFile | Add File | Optional (Multiple occurrences allowed) | • File Name must be unique within a folder • File Description must be unique within a folder • Folder ID must belong to specified Opportunity ID |
GrantsRelatedDocument_V1.0: AddFile |
| ReplaceFile | Replace File | Optional (Multiple occurrences allowed) | • File Name must be unique within a folder • File Description must be unique within a folder • File ID must belong to specified Opportunity ID • File and File Name must be provided if either is provided |
GrantsRelatedDocument_V1.0: ReplaceFile |
| RemoveFile | Remove File | Optional (Multiple occurrences allowed) | • File ID must belong to specified Opportunity ID | GrantsRelatedDocument_V1.0: RemoveFile |
Return Values
This service returns a collection of objects containing the following details:
| Return Value | Comment / Example | Required/Optional | Web Service Schema |
|---|---|---|---|
| CompletionStatus | Success, Partial, Fail | Required | GrantsCommonElements: CompletionStatus |
| ErrorDetails | Optional | GrantsCommonElements: ErrorDetails | |
| AddFileResult | Optional (May have multiple occurrences) | GrantsRelatedDocument_V1.0: AddFileResult | |
| ReplaceFileResult | Optional (May have multiple occurrences) | GrantsRelatedDocument_V1.0: ReplaceFileResult | |
| RemoveFileResult | Optional (May have multiple occurrences) | GrantsRelatedDocument_V1.0: RemoveFileResult |