GrantsCommonElements-V1.0.xsd

The "Grants Common Types" 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:
http://at07apply.grants.gov/apply/system/schemas/GrantsCommonElements-V1.0.xsd

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

Schema Elements

Element / Sub-Element Name Element Type Element Rules Required/
Optional
CompetitionID GrantsCommonTypes: CompetitionIDType    
CompetitionTitle GrantsCommonTypes: CompetitionTitleType    
GrantsGovTrackingNumber GrantsCommonTypes: GrantsGovTrackingNumberType    
PostingDate GrantsCommonTypes: MMDDYYYYFwdSlashType    
FundingOpportunityNumber GrantsCommonTypes: FundingOpportunityNumberType    
UserID GrantsCommonTypes: UserIDType    
FundingOpportunityTitle GrantsCommonTypes: StringWithoutNewLine255Type    
ClosingDate GrantsCommonTypes: MMDDYYYYFwdSlashType    
ArchiveDate GrantsCommonTypes: MMDDYYYYFwdSlashType    
CFDANumber GrantsCommonTypes: CFDANumberType    
SendChangeNotificationEmail String Valid values:
  • Y
  • N
 
ModificationComments String Min length: 1
Max length:2000
 
CompetitionInfo Complex    
CompetitionID GrantsCommonTypes: CompetitionIDType   Required
CompetitionTitle GrantsCommonTypes: CompetitionTitleType   Required
ResponseMessage String Valid values:
  • Success
  • Failure
 
InstructionFileInfo Complex    
FileName GrantsCommonTypes: FileNameType   Required
FileExtension GrantsCommonTypes: FileExtensionType   Required
FileContentId GrantsCommonTypes: FileContentIdType   Required
FileDataHandler xs:base64Binary (streamed to the client) application/octet-stream Required
Attachment Complex    
FileContentId GrantsCommonTypes: FileContentIdType   Required
FileDataHandler xs:base64Binary (streamed to the client) application/octet-stream Required
ApplicationFilter Complex    
Filter String Valid values:
  • Status
  • OpportunityID
  • CFDANumber
  • SubmissionTitle
  • GrantsGovTrackingNumber
Optional
FilterValue String Valid "Status" values:
  • Receiving
  • Received
  • Processing
  • Validated
  • Rejected with Errors
  • Received by Agency
  • Agency Tracking Number Assigned
Optional
FilterType String Valid values:
  • Status
  • OpportunityID
  • CFDANumber
Required
Token Complex    
UserID GrantsCommonTypes: UserIDType   Required
TokenId GrantsCommonTypes: TokenIdType   Optional
DUNS GrantsCommonTypes: DUNSType   Optional
FullName GrantsCommonTypes: FullNameType   Optional
AORStatus GrantsCommonTypes: AORStatusType   Required
TokenExpiration dateTime   Optional
SecurityMessage Complex    
MessageCode GrantsCommonTypes: MessageCodeType   Required
MessageText GrantsCommonTypes: MessageTextType   Required
ErrorDetails Complex    
Code GrantsCommonTypes: MessageCodeType   Required
Message GrantsCommonTypes: MessageTextType   Required
AgencyTrackingNumber GrantsCommonTypes: StringMin1Max240Type    
SubmissionTitle GrantsCommonTypes: StringMin1Max240Type    
OfferingAgency GrantsCommonTypes: StringMin1Max255Type    
GrantsGovApplicationStatus GrantsCommonTypes: GrantsGovApplicationStatusType    
AgencyContactInfo GrantsCommonTypes: AgencyContactInfoType    
CFDADescription GrantsCommonTypes: StringWithoutNewLine255Type    
SchemaURL GrantsCommonTypes: StringWithoutNewLine255Type    
InstructionsURL GrantsCommonTypes: StringWithoutNewLine255Type    
StatusDetail GrantsCommonTypes: StatusDetailType    
AgencyNotes GrantsCommonTypes: AgencyNotesType