Manage Related Opportunities
ManageRelatedOpportunities
This service adds, modifies, and removes one or more opportunity relationship(s).
Input Parameters
This service requires the following request parameter(s):
| Input Parameter | Description | Required/Optional | Business Rules | Web Service Schema |
|---|---|---|---|---|
| AddRelatedOpportunity |
Add Related Opportunity |
Optional (Multiple occurrences allowed) |
See below for business rules |
GrantsOpportunity_V1.0: AddRelatedOpportunity |
| ModifyRelatedOpportunity | Modify Related Opportunity | Optional (Multiple occurrences allowed) |
See below for business rules |
GrantsOpportunity_V1.0: ModifyRelatedOpportunity |
| RemoveRelatedOpportunity | Remove Related Opportunity | Optional (Multiple occurrences allowed) | See below for business rules | GrantsOpportunity_V1.0: RemoveRelatedOpportunity |
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 | |
| AddRelatedOpportunityResult | Optional (May have multiple occurrences) | GrantsOpportunity_V1.0: AddRelatedOpportunityResult | |
| ModifyRelatedOpportunityResult | Optional (May have multiple occurrences) | GrantsOpportunity_V1.0: ModifyRelatedOpportunityResult | |
| RemoveRelatedOpportunityResult | Optional (May have multiple occurrences) | GrantsOpportunity_V1.0: RemoveRelatedOpportunityResult |
Business Rules
The following are the business rules for this service:
At least one action must be specified (for Add/Modify/Remove Related Opportunity)
Certificate must have at least one of the following roles:
- Manage Forecasts
- Manage Synopses
- Manage PackagesTo add an Opportunity Relationship, both Opportunity IDs must be non-deleted, non-draft, and belong to Agency associated with the certificate (or any of its Sub-Agencies if certificate has Manage Agencies role)
Note: Opportunities in Draft status are not currently retrievable by S2S
Cannot add an Opportunity relationship that already exists
To modify/remove an Opportunity Relationship, at least one of the Opportunity IDs must belong to Agency associated with the certificate (or any of its Sub-Agencies if certificate has Manage Agencies role)
Cannot modify/remove an Opportunity Relationship that does not exist, and both opportunities must be non-draft since S2S cannot currently retrieve draft opportunities
Cannot relate an Opportunity to itself