ManagePackage

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

Web Service Version(s)

  • V1
  • V2.0

NOTE: S2S V0 and V1 end points will be discontinued effective January 1, 2016. Please use or upgrade to the S2S V2.0 end point.

Input Parameters

In V1, the following input parameter(s) were defined in the AgencyManagePackageXML schema:

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
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