Applicant Common Elements

ApplicantCommonElements-V1.0.xsd

The 'Applicant Common Elements' schema is a new common schema added to standardize the naming convention:

Web Service Version(s)

  • V2.0

Schema Link

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

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

Schema Elements

Element / Sub-Element Name Element Type Element Rules Required/
Optional
OpportunityFilter Complex One sub-element is required  
FundingOpportunityNumber GrantsCommonElements: FundingOpportunityNumber Ex: 03272012-KJ-SP-MP  
CFDANumber GrantsCommonElements: CFDANumber Ex: 00.000  
CompetitionID GrantsCommonElements: CompetitionID Ex: 03272012-KJ-SP-MP  
SubmissionFilter Complex    
Type ApplicantCommonElements: SubmissionFilterType   Required
Value GrantsCommonTypes: StringMin1Max255Type   Required
SubmissionFilterType String Valid values:
  • FundingOpportunityNumber
  • GrantsGovTrackingNumber
  • PackageID
  • SubmissionTitle
  • Status
  
OpportunityDetails Complex    
FundingOpportunityNumber GrantsCommonElements: FundingOpportunityNumber Ex: 04252012-NF1  
FundingOpportunityTitle GrantsCommonElements: FundingOpportunityTitle Ex: RG-07252011-Opp36-Title-Mod-Email!  
CompetitionID GrantsCommonElements: CompetitionID Ex: 04252012-NF-MP1  
CompetitionTitle GrantsCommonElements: CompetitionTitle Ex: STD589 proposals  
PackageID GrantsCommonElements: PackageID Ex: PKG12345678  
CFDADetails ApplicantCommonElements: CFDADetails   Optional (May have multiple occurrences)
OpeningDate

date

 Format: YYYY-MM-DD  
ClosingDate date Format: YYYY-MM-DD  
OfferingAgency GrantsCommonElements: OfferingAgency Ex: NIH  
AgencyContactInfo GrantsCommonElements: AgencyContactInfo Agency Contact Number  
SchemaURL GrantsCommonElements: SchemaURL Ex: https://trainingapply.grants.gov/apply/opportunities/schemas/ applicant/<Package ID>.xsd  
InstructionsURL GrantsCommonElements: InstructionsURL Ex: https://trainingapply.grants.gov/apply/opportunities/ instructions/<Package ID>-instructions.doc  
IsMultiProject Boolean Values: True/False  
SubmissionDetails Complex    
GrantsGovTrackingNumber GrantsCommonElements: GrantsGovTrackingNumber Ex: GRANT10578935  
AgencyTrackingNumber GrantsCommonElements: AgencyTrackingNumber    
GrantsGovApplicationStatus GrantsCommonElements: GrantsGovApplicationStatus

Valid values:

  • Receiving
  • Received
  • Processing
  • Validated
  • Rejected with Errors
  • Download Preparation
  • Received by Agency
  • Agency Tracking Number Assigned
  
ReceivedDateTime

dateTime

 Format: YYYY-MM-DDThh:mm:ss  
StatusDateTime dateTime Format: YYYY-MM-DDThh:mm:ss  
FundingOpportunityNumber GrantsCommonElements: FundingOpportunityNumber Ex: 03272012-KJ-SP-MP  
SubmissionTitle GrantsCommonElements: SubmissionTitle    
PackageID GrantsCommonElements: PackageID Ex: PKG12345678  
CFDADetails Complex    
Number GrantsCommonTypes: CFDANumberType Ex: 10.001  
Title GrantsCommonTypes: StringWithoutNewLine255Type Ex: Agricultural Research_Basic and Applied Research