ManagePackage

This web service creates, deletes, and updates Single-Package opportunities.

NOTE: This web service was replaced by the Create Opportunity Package, Update Opportunity Package, and Delete Opportunity Package web services and will be retired on December 31, 2019.

Web Service Version(s)

  • V2.0

Input Parameters

Input Parameter Description Required / Optional Business Rules V2.0 Web Service Schema
UserID UserID of the grantor creating the opportunity. It must be of a grantor under the same or a sub-agency of S2S user Required   GrantsCommonElements: UserID
AgencyCode Agency code of the grantor agency for the opportunity Optional

• Agency Code is used to uniquely identify an Opportunity

• For a specified User ID with only one profile, the optional Agency Code is not needed

• For a specified User ID with multiple profiles, the Agency Code must be specified to determine unique Agency Code

• If Agency Code is specified, the User ID is ignored and the certificate used must have the Manage Agencies role to Manage Opportunities for a sub-agency

GrantsCommonElements: AgencyCode
FundingOpportunityNumber   Required Must be an existing opportunity, or newly created if "CreateOpportunityInfo" is specified in XML for your agency GrantsCommonElements: FundingOpportunityNumber
CreateOpportunityInfo Creates Opportunity based on the XML Schema Optional See schema documentation for details AgencyManagePackage: CreateOpportunityInfo
CreatePackageInfo Creates Package based on the XML Schema Optional (Multiple occurrences allowed) See schema documentation for details AgencyManagePackage: CreatePackageInfo
UpdatePackageInfo Update Package based on the XML Schema Optional (Multiple occurrences allowed) See schema documentation for details AgencyManagePackage: UpdatePackageInfo
DeletePackageInfo Delete Package based on the XML Schema Optional (Multiple occurrences allowed) See schema documentation for details AgencyManagePackage: DeletePackageInfo

Return Values

This service returns a collection of objects containing the following details:

Return Value Comment / Example Required / Optional V2.0 Web Service Schema
UserID Galexandr Required GrantsCommonElements: UserID
FundingOpportunityNumber 05292012-KJ-FIF Required GrantsCommonElements: FundingOpportunityNumber
Success True Required  
CreatePackageResult Competition ID: 02032011-AGS2S-01-COMPID-02 /CFDA Number: 00.000) - Success! Optional (May have multiple occurrences) AgencyManagePackage: CreatePackageResult
UpdatePackageResult   Optional (May have multiple occurrences) AgencyManagePackage: UpdatePackageResult
DeletePackageResult   Optional (May have multiple occurrences) AgencyManagePackage: DeletePackageResult