AgencyManagePackageXML-V1.0.xsd

Web Service Version(s)

  • V1

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.

Schema Link

For the Training Environment, this schema is located at:
https://trainingws.grants.gov/grantsws-agency/schema/AgencyManagePackageXml-V1.0.xsd

For the Production Environment, this schema is located at:
https://ws07.grants.gov/grantsws-agency/schema/AgencyManagePackageXml-V1.0.xsd

Schema Elements

Element / Sub-Element Name Element Type Element Rules Required / Optional
UserID agencympx: UserIDType   Required
OpportunityNumber agencympx: OpportunityNumberType   Required
CreateOpportunityInfo      
OpportunityTitle   Cannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
Required
OpportunityCategory agencympx: OpportunityCategoryType   Required
OpportunityCategoryExplanation   Begin with letter or number - followed by any sequence of characters Optional
CFDANumber agencympx: CFDANumberType   Optional
CreatePackageInfo Complex    
CFDANumber agencympx: CFDANumberType    
CompetitionInfo agencympx: CompetitionInfoType    
ElectronicRequired agencympx: ElectronicRequiredType    
ExpectedApplicationCount agencympx: ExpectedApplicationCountType    
ExpectedApplicationSizeMB String Positive Numeric Optional
OpeningDate String MM/DD/YYYY Optional
ClosingDate agencympx: ClosingDateType   Required
GracePeriodDays String Number Optional
AgencyContactInfo agencympx: AgencyContactInfoType   Required
TemplateName agencympx: TemplateNameType   Required
InstructionFileInfo agencympx: InstructionFileInfoType   Required
OpenToApplicantType agencympx: ApplicantType   Required
UpdatePackageInfo Complex    
CFDANumber agencympx: CFDANumberType   Optional
CompetitionID agencympx: CompetitionIDType   Optional
CompetitionTitle agencympx: CompetitionTitleType   Optional
ElectronicRequired agencympx: ElectronicRequiredType   Optional
ExpectedApplicationCount agencympx: ExpectedApplicationCountType   Optional
ExpectedApplicationSizeMB String Valid values: - DELETE: to clear current value - positive number  
OpeningDate String Valid values: - DELETE: to clear current value - MM/DD/YYYY Optional
ClosingDate agencympx: ClosingDateType   Required
GracePeriodDays String Valid values: - DELETE: to clear current value - positive number Optional
AgencyContactInfo agencympx: AgencyContactInfoType   Optional
TemplateName agencympx: TemplateNameType   Optional
InstructionFileInfo agencympx: InstructionFileInfoType   Optional
OpenToApplicantType agencympx: ApplicantType   Optional
EmailInfo agencympx: EmailInfoType   Optional
DeletePackageInfo Complex   Optional
CFDANumber agencympx: CFDANumberType    
CompetitionID agencympx: CompetitionIDType    
UserIDType String Valid characters: spaces and non-whitespace characters
Invalid: line feeds, tabs, carriage returns
Required
OpportunityNumberType String Valid characters: Uppercase letters, numeric, and hyphens
Max length: 40
Required
OpportunityCategoryType String Valid values:
D(DISCRETIONARY)
MMANDATORY)
C(CONTINUATION)
E(EARMARK)
O(OTHER)
 
CFDANumberType String ##.### where # is numeric  
CompetitionInfoType Complex Used for CreatePackageInfo where comp ID and title are required if used  
CompetitionID agencympx: CompetitionIDType   Required
CompetitionTitle agencympx: CompetitionTitleType   Required
CompetitionIDType String Valid characters: Uppercase letters, numeric, and hyphens
Max length: 40
 
CompetitionTitleType String Cannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
 
ElectronicRequiredType String Valid values:
True
False
 
ExpectedApplicationCountType String Positive Number  
ClosingDateType String MM/DD/YYYY  
AgencyContactInfoType String Min length: 1
Max length: 2000
 
TemplateNameType String Cannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
 
InstructionFileInfoType String Cannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
 
FileExtension String Cannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 15
 
ContentId String Cannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
Required
ApplicantType String Valid values:
ORGANIZATIONS_ONLY
INDIVIDUALS_ONLY
INDIVIDUALS_AND_ORGANIZATIONS
 
EmailInfoType      
SendEmail String Valid values:
True
False
Required
EmailComments String Min length: 1
Max length: 2000
Optional