Agency Manage Package

AgencyManagePackage-V1.0.xsd

Web Service Version(s)

  • V2.0

Schema Link

For the Training Environment, this schema is located at:
https://trainingapply.grants.gov/apply/system/schemas/AgencyManagePackage-V1.0.xsd

For the Production Environment, this schema is located at:
https://apply07.grants.gov/apply/system/schemas/AgencyManagePackage-V1.0.xsd

Schema Elements

Element / Sub-Element Name Element Type Element Rules Required / Optional
CreatePackageInfo Complex    
CFDANumber GrantsCommonElements: CFDANumber   Optional
CompetitionInfo GrantsCommonElements: CompetitionInfo   Optional
ElectronicSignatureRequired AgencyManagePackage: ElectronicSignatureRequired   Required
ExpectedApplicationCount AgencyManagePackage: ExpectedApplicationCount   Required
ExpectedApplicationSizeMB AgencyManagePackage: ExpectedApplicationSizeMB   Optional
OpeningDate AgencyManagePackage: OpportunityDateType   Optional
ClosingDate AgencyManagePackage: OpportunityDateType   Required
GracePeriodDays AgencyManagePackage: GracePeriodDays   Optional
AgencyContactInfo GrantsCommonElements: AgencyContactInfo   Required
TemplateName GrantsCommonTypes: TemplateNameType   Required
InstructionFileInfo GrantsCommonElements: InstructionFileInfo   Required
OpenToApplicant AgencyManagePackage: OpenToApplicant   Required
UpdatePackageInfo Complex    
CFDANumber GrantsCommonElements: CFDANumber   Optional
CompetitionID GrantsCommonElements: CompetitionID   Optional
CompetitionTitle GrantsCommonElements: CompetitionTitle   Optional
ElectronicSignatureRequired AgencyManagePackage: ElectronicSignatureRequired   Optional
ExpectedApplicationCount AgencyManagePackage: ExpectedApplicationCount   Optional
ExpectedApplicationSizeMB AgencyManagePackage: ExpectedApplicationSizeMB   Optional
OpeningDate AgencyManagePackage: OpportunityDateType   Optional
ClosingDate AgencyManagePackage: OpportunityDateType   Required
GracePeriodDays AgencyManagePackage: GracePeriodDays   Optional
AgencyContactInfo GrantsCommonElements: AgencyContactInfo   Optional
TemplateNameType GrantsCommonTypes: TemplateNameType   Optional
InstructionFileInfo GrantsCommonElements: InstructionFileInfo   Optional
OpenToApplicant AgencyManagePackage: OpenToApplicant   Optional
EmailInfo AgencyManagePackage: EmailInfo   Required
DeletePackageInfo Complex    
CFDANumber GrantsCommonElements: CFDANumber   Optional
CompetitionID GrantsCommonElements: CompetitionID   Optional
CreatePackageResult Complex    
CompetitionID GrantsCommonElements: CompetitionID   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional
ErrorDetails GrantsCommonElements: ErrorDetails   Optional
UpdatePackageResult Complex    
CompetitionID GrantsCommonElements: CompetitionID   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional
NotificationCount xs:int   Optional
ErrorDetails GrantsCommonElements: ErrorDetails   Optional
DeletePackageResult Complex    
CompetitionID GrantsCommonElements: CompetitionID   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional
NotificationCount xs:int   Optional
ErrorDetails GrantsCommonElements: ErrorDetails   Optional
CreateOpportunityInfo ComplexType containing the following elements:    
FundingOpportunityTitle GrantsCommonElements: FundingOpportunityTitle   Required
OpportunityCategory GrantsCommonTypes: OpportunityCategoryType   Required
OpportunityCategoryExplanation AgencyManagePackage: OpportunityCategoryExplanation   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional (Multiple Occurrences Allowed)
OpportunityCategoryExplanation String Begins with letter or number
Followed by any sequence of characters
Max length: 100
 
GracePeriodDays String "DELETE" (To delete the current value)
Numeric
 
ExpectedApplicationSizeMB String "DELETE" (To delete the current value)
Numeric
 
EmailInfo Complex    
SendChangeNotificationEmail GrantsCommonElements: SendChangeNotificationEmail   Optional
ModificationComments GrantsCommonElements: ModificationComments   Required
ElectronicSignatureRequired String Valid Values:
Y
N
 
OpenToApplicant String Valid Values:
ORGANIZATIONS_ONLY
INDIVIDUALS_ONLY
INDIVIDUALS_AND_ORGANIZATIONS
 
ExpectedApplicationCount String Numeric
>= 0
 
OpportunityDateType String MM/DD/YYYY