Delete Opportunity Forecast
DeleteOpportunityForecast
This service deletes one or more Forecasts if Opportunity has other components.
Input Parameters
This service requires the following request parameter(s):
| Input Parameter | Description | Required/Optional | Business Rules | Web Service Schema |
|---|---|---|---|---|
| DeleteForecastInfo DeleteForecast |
The information required to delete forecast. | Required (Multiple Occurrences Allowed) | • Certificate must have Manage Forecasts role • Forecast cannot be updated/deleted if it does not exist |
GrantsForecastSynopsis_V1.0 |
| OpportunityID | Opportunity ID | Required | • Opportunity ID must belong to Agency associated with the certificate (or any of its Sub-Agencies if certificate has Manage Agencies role) • If Opportunity only has a Forecast, Delete Adobe Opportunity must be used to delete the Forecast |
GrantsCommonElements: OpportunityID |
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 | |
| DeleteForecastResult | Optional (May have multiple occurrences) | GrantsCommonElements | |
| Success | True, False | Required | |
| OpportunityID ErrorDetails |
Optional | GrantsCommonElements |