Manage Related Document Files
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 |
|
GrantsCommonElements: OpportunityID |
ModificationComments | Modification Comments | Optional |
|
GrantsCommonElements: ModificationComments |
AddFile | Add File | Optional (Multiple occurrences allowed) |
|
GrantsRelatedDocument_V1.0: AddFile |
ReplaceFile | Replace File | Optional (Multiple occurrences allowed) |
|
GrantsRelatedDocument_V1.0: ReplaceFile |
RemoveFile | Remove File | Optional (Multiple occurrences allowed) |
|
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 |