Web Content Display

GrantsPackage-V1.0.xsd

The 'Grants Package' schema is a new common schema added to standardize the definition of the common elements.

Web Service Version(s)

  • V2.0

Schema Link

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

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

Schema Elements

Element Name / Sub-Element Name Element Type Element Rules Required / Optional
CreatePackage Complex    
CompetitionID GrantsCommonElements: CompetitionID   Optional
CFDANumber GrantsCommonElements: CFDANumber   Optional
CompetitionTitle GrantsCommonElements: CompetitionTitle   Optional

ElectronicRequired

GrantsPackage: ElectronicRequired   Required
ExpectedApplicationCount GrantsPackage: ExpectedApplicationCount   Required
ExpectedApplicationSizeMB GrantsPackage: ExpectedApplicationSizeMB   Optional
OpeningDate GrantsPackage: OpeningDate   Optional
ClosingDate GrantsPackage: ClosingDate   Required
GracePeriodDays GrantsPackage: GracePeriodDays   Optional
AgencyContactName GrantsPackage: AgencyContactName   Required
InstructionFile GrantsPackage: InstructionFile   Required
ApplicantType GrantsPackage: ApplicantType   Required
CreatePackageForms GrantsPackage: CreatePackageForms   Required
UpdatePackage Complex    
PackageID GrantsCommonElements: PackageID   Required
CompetitionTitle GrantsCommonElements: CompetitionTitle   Optional
ElectronicRequired GrantsPackage: ElectronicRequired   Optional
ExpectedApplicationCount GrantsPackage: ExpectedApplicationCount   Optional
ExpectedApplicationSizeMB GrantsPackage: ExpectedApplicationSizeMB   Optional
OpeningDate GrantsPackage: OpeningDate   Optional
ClosingDate GrantsPackage: ClosingDate   Optional
GracePeriodDays GrantsPackage: GracePeriodDays   Optional
AgencyContactName GrantsPackage: AgencyContactName   Optional
InstructionFile GrantsPackage: InstructionFile   Optional
ApplicantType GrantsPackage: ApplicantType   Optional
UpdatePackageForms GrantsPackage: UpdatePackageForms   Optional
SendUpdateNotificationEmail GrantsCommonElements: SendUpdateNotificationEmail   Optional
UpdateComments GrantsCommonElements: UpdateComments   Required
DeletePackage Complex    
PackageID GrantsCommonElements: PackageID   Required
SendDeleteNotificationEmail GrantsCommonElements: SendDeleteNotificationEmail   Optional
DeleteComments GrantsCommonElements: DeleteComments   Required
InstructionFile Complex   Required
FileName GrantsCommonElements: FileName   Required
FileDataHandler base64Binary   Required
CreatePackageForms Complex   Required
CreateSingleProjectPackageForm GrantsPackage: CreateSingleProjectPackageForm   Required
CreateMultiProjectPackageForm GrantsPackage: CreateMultiProjectPackageForm    
CreateSingleProjectPackageForm Complex    
TemplateName GrantsPackage: TemplateName   Required
CreateMultiProjectPackageForm Complex    
AgencyDownloadUrl GrantsPackage: AgencyDownloadUrl   Required
CreateOverallPackage GrantsPackage: CreateOverallPackage   Required
CreateSubApplicationGroup GrantsPackage: CreateSubApplicationGroup   Optional (Multiple occurrences allowed)
CreateOverallPackage Complex    
GroupName GrantsPackage: GroupName   Required
TemplateName GrantsPackage: TemplateName   Required
CreateSubApplicationGroup Complex    
GroupName GrantsPackage: GroupName   Required
MinIterations GrantsPackage: MinIterations   Required
MaxIterations GrantsPackage: MaxIterations   Required
TemplateName GrantsPackage: TemplateName   Required
UpdatePackageForms Complex   Optional
UpdateSingleProjectPackageForm GrantsPackage: UpdateSingleProjectPackageForm    
UpdateMultiProjectPackageForm GrantsPackage: UpdateMultiProjectPackageForm    
UpdateSingleProjectPackageForm Complex    
TemplateName GrantsPackage: TemplateName   Optional
UpdateMultiProjectPackageForm Complex    
AgencyDownloadUrl GrantsPackage: AgencyDownloadUrl   Optional
UpdateOverallPackage GrantsPackage: UpdateOverallPackage   Optional
UpdateSubApplicationGroup GrantsPackage: UpdateSubApplicationGroup   Optional (Multiple occurrences allowed)
UpdateOverallPackage Complex    
GroupName GrantsPackage: GroupName   Optional
TemplateName GrantsPackage: TemplateName   Optional
UpdateSubApplicationGroup Complex    
GroupName GrantsPackage: GroupName   Required
MinIterations GrantsPackage: MinIterations   Optional
MaxIterations GrantsPackage: MaxIterations   Optional
TemplateName GrantsPackage: TemplateName   Optional
OpeningDate GrantsCommonTypes: MMDDYYYYFwdSlashType    
ClosingDate GrantsCommonTypes: MMDDYYYYFwdSlashType    
AgencyDownloadUrl GrantsCommonTypes: StringMin1Max255Type    
TemplateName GrantsCommonTypes: TemplateNameType    
GroupName GrantsCommonTypes: StringMin1Max30Type    
MinIterations GrantsCommonTypes: Number8DigitsType    
MaxIterations GrantsCommonTypes: Number8DigitsOrUnboundedType    
ElectronicRequired GrantsCommonTypes: YesNoType    
ShortFormName GrantsCommonTypes: StringMin1Max75Type    
FormName GrantsCommonTypes: StringMin1Max255Type    
FormVersion GrantsCommonTypes: StringMin1Max25Type    
FormID GrantsCommonTypes: Number15DigitsType    
FormFamily GrantsCommonTypes: StringMin1Max255Type    
GracePeriodDays GrantsCommonTypes: Number4DigitsType    
ExpectedApplicationSizeMB GrantsCommonTypes: Number8DigitsType    
ExpectedApplicationCount GrantsCommonTypes: Number8DigitsType    
AgencyContactName GrantsCommonTypes: StringMin1Max2000Type    
PackageType GrantsPackage: PackageType    
FormType GrantsPackage: FormType    
ApplicantType GrantsPackage: ApplicantType    
PackageType String Valid values:
SingleProject
MultiProject
 
FormType String Valid values:
Optional
Mandatory
 
ApplicantType String Valid values:
ORGANIZATIONS_ONLY
INDIVIDUALS_ONLY
INDIVIDUALS_AND_ORGANIZATIONS
 
PackageDetails Complex    
PackageID GrantsCommonElements: PackageID    
CFDANumber GrantsCommonElements: CFDANumber   Optional
CompetitionID GrantsCommonElements: CompetitionID   Optional
CompetitionTitle GrantsCommonElements: CompetitionTitle   Optional

ElectronicRequired

GrantsPackage: ElectronicRequired   Optional
ExpectedApplicationCount GrantsPackage: ExpectedApplicationCount   Optional
ExpectedApplicationSizeMB GrantsPackage: ExpectedApplicationSizeMB   Optional
OpeningDate GrantsPackage: OpeningDate   Optional
ClosingDate GrantsPackage: ClosingDate   Optional
GracePeriodDays GrantsPackage: GracePeriodDays   Optional
AgencyContactName GrantsPackage: AgencyContactName   Optional
InstructionFileDetails GrantsPackage: InstructionFileDetails   Optional
ApplicantType GrantsPackage: ApplicantType   Optional
PackageType GrantsPackage: PackageType   Optional
PackageFormsDetails GrantsPackage: PackageFormsDetails   Optional
LastUpdatedTimestamp GrantsCommonElements: LastUpdatedTimestamp   Optional
PackageFormsDetails Complex    
SingleProjectFormDetails GrantsPackage: SingleProjectFormDetails   Optional
MultiProjectFormDetails GrantsPackage: MultiProjectFormDetails   Optional
SingleProjectFormDetails Complex    
TemplateName GrantsPackage: TemplateName   Optional
FormFamily GrantsPackage: FormFamily   Optional
FormDetails GrantsPackage: FormDetails   Optional (Multiple occurrences allowed)
MultiProjectPackageForm Complex    
AgencyDownloadUrl GrantsPackage: AgencyDownloadUrl   Optional
OverallFormDetails GrantsPackage: OverallFormDetails   Optional
SubApplicationGroupDetails GrantsPackage: SubApplicationGroupDetails   Optional (Multiple occurrences allowed)
OverallFormDetails Complex    
GroupName GrantsPackage: GroupName   Optional
TemplateName GrantsPackage: TemplateName   Optional
FormFamily GrantsPackage: FormFamily   Optional
FormDetails GrantsPackage: FormDetails   Optional (Multiple occurrences allowed)
SubApplicationGroupDetails Complex    
GroupName GrantsPackage: GroupName   Optional
MinIterations GrantsPackage: MinIterations   Optional
MaxIterations GrantsPackage: MaxIterations   Optional
TemplateName GrantsPackage: TemplateName   Optional
FormFamily GrantsPackage: FormFamily   Optional
FormDetails GrantsPackage: FormDetails   Optional (Multiple occurrences allowed)
FormDetails Complex    
FormName GrantsPackage: FormName   Optional
FormVersion GrantsPackage: FormVersion   Optional
FormID GrantsPackage: FormID   Optional
FormType GrantsPackage: FormType   Optional
InstructionFileDetails Complex    
FileName GrantsCommonElements: FileName   Optional
FileMIMEType GrantsCommonElements: FileMIMEType   Optional
LastUpdatedTimestamp GrantsCommonElements: LastUpdatedTimestamp   Optional
FileDataHandler base64Binary   Optional