CreateOpportunityPackage

This service creates one or more Single-Project or Multi-Project Packages for a specific Opportunity.

Input Parameters

This service requires the following request parameter(s):

Input Parameter Description Required/Optional Business Rules Web Service Schema
CreatePackageInfo
CreatePackage		 The information required to create package. Required (Multiple Occurrences Allowed) See below for business rules GrantsPackage_V1.0: CreatePackage
OpportunityID Opportunity ID Optional Must provide either OpportunityID or CreateOpportunity GrantsCommonElements: OpportunityID
CreateOpportunity If Opportunity does not exist (Opportunity ID is not specified), create Opportunity. Optional Must provide either OpportunityID or CreateOpportunity GrantsOpportunity: CreateOpportunity

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
OpportunityID
FundingOpportunityNumber
AgencyCode
ErrorDetails		   Optional GrantsCommonElements
CreatePackageResult   Optional (May have multiple occurrences) GrantsCommonElements
Success True, False Required  
PackageID
CFDANumber
CompetitionID
InstructionFileLastUpdatedTimestamp		   Optional GrantsCommonElements
PackageFormDetails Single-Project Package Form Details or Multi-Project Package Form Details Optional GrantsPackage_V1.0: PackageFormsDetails
ErrorDetails   Optional (May have multiple occurrences) GrantsCommonElements: ErrorDetails

 

Business Rules

The following are the business rules for this service:

  • Agency Code must match Agency associated with the certificate (or any of its Sub-Agencies if certificate has Manage Agencies role)
  • Opportunity Number must be unique across all Agencies
  • Opportunity Category Explanation is required if Opportunity Category is ‘Other'
  • Opportunity Category Explanation must be blank when Opportunity Category is not ‘Other'
  • Opportunity CFDA(s) must be active in Grants.gov
  • Opportunity CFDA(s) must be unique for the Opportunity
  • CFDA for the Package must be one of the Opportunity CFDA(s)
  • Combination of Competition ID, CFDA Number and Opportunity Number must be unique
  • Certificate must have Manage Packages role
  • Opportunity ID must belong to Agency associated with the certificate (or any of its Sub-Agencies if certificate has Manage Agencies role)
  • Competition Title is required if Competition ID is not blank
  • Competition Title must be blank if Competition ID is blank
  • Closing Date must be the same or later than Opening Date
  • Closing Date must be in the future
  • Template Name must exist in Grants.gov
  • If Single-Project Package, Template must contain a mandatory SF-424 form
  • If Multi-Project Package, Overall Template must contain a mandatory SF-424 form
  • Multi-Project Templates are only available to Agencies with Multi-Project feature
  • Label must be unique with a Multi-Project Package
  • Multi-Project Packages are only available to Agencies with Multi-Project feature
  • Max Iterations must be equal or greater than Min Iterations for Sub-Application groups
  • Grants.gov Closings Calendar limit exceeded for specified Closing Date – Closing Date must be changed to a different day or contact PMO to request limit increase
  • Instructions file cannot contain a virus
  • Label must begin with a letter; only contain letters, numbers, spaces and underscores; and cannot equal ‘XML'