Manage Related Document Links

ManageRelatedDocumentLinks

This service adds, updates, and deletes one or more Related Document 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
  • At least one of the following actions must be specified: Create Link, Update Link, or Delete Link
  • 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
 GrantsCommonElements: OpportunityID
ModificationComments Modification Comments Optional
  • If modification comments are specified, Opportunity will be included in the nightly email notification
 GrantsCommonElements: ModificationComments
CreateLink Create Link Optional (Multiple occurrences allowed)
  • Link Description must be unique for the Opportunity
  • Link URL must be unique for the Opportunity
  • Link URL must begin with http:// or https://
 GrantsRelatedDocument_V1.0: CreateLink
UpdateLink Update Link Optional (Multiple occurrences allowed)
  • Link Description must be unique for the Opportunity
  • Link URL must be unique for the Opportunity
  • Link URL must begin with http:// or https://
  • Link ID must belong to specified Opportunity ID
 GrantsRelatedDocument_V1.0: UpdateLink
DeleteLink Delete Link Optional (Multiple occurrences allowed)
  • Link ID must belong to specified Opportunity ID
 GrantsRelatedDocument_V1.0: DeleteLink

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
CreateLinkResult   Optional (May have multiple occurrences) GrantsRelatedDocument_V1.0: CreateLinkResult
UpdateLinkResult   Optional (May have multiple occurrences) GrantsRelatedDocument_V1.0: UpdateLinkResult
DeleteLinkResult   Optional (May have multiple occurrences) GrantsRelatedDocument_V1.0: DeleteLinkResult