Skip Navigation
Grants.Gov

Applicant Schemas

Common Schemas

Grants.gov common schemas are schemas that include re-usable elements and element type definitions.

GrantsCommonTypes-V1.0.xsd

The ‘Grants Common Types’ schema is a new common schema was 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:
http://at07apply.grants.gov/apply/system/schemas/GrantsCommonTypes-V1.0.xsd


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

Schema Elements

Element NameElement TypeElement Rules
MMDDYYYYFwdSlashTypeStringMM/DD/YYYY format
No whitespaces
StringWithoutNewLine255TypeStringCannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
StringMin1Max240TypeStringMin length: 1
Max length: 240
StringMin1Max255TypeStringMin length: 1
Max length: 255
Valid characters: spaces and non-whitespace characters
Invalid characters: line feeds, tabs, carriage returns
UserIDTypeStringValid characters: Uppercase letters, numeric, and hyphens
Max length: 40
FundingOpportunityNumberTypeStringValid characters: Uppercase letters, numeric, and hyphens - Max length: 40
OpportunityCategoryTypeStringValid values:
D (Discretionary)
M (Mandatory)
C (Continuation)
E (Earmark)
O (Other)
TemplateNameTypeStringCannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
FileNameTypeStringCannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
FileContentIdTypeStringCannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
CFDANumberTypeStringValid format: ##.### where # is numeric only
No whitespace
CompetitionIDTypeStringValid characters: Uppercase letters, numeric, and hyphens
Max length: 40
No whitespace
CompetitionTitleTypeStringCannot begin with whitespace character (line feeds, tabs, spaces, carriage returns)
Can be any sequence of characters except new-line
Max length: 255
GrantsGovTrackingNumberTypeStringValid format: Uppercase GRANTxxxxxxxx where 'x' is numeric only (i.e. GRANT12345678 )
GrantsGovApplicationStatusTypeStringValid values:
Receiving
Received
Processing
Validated
Rejected with Errors
Download Preparation
Received by Agency
Agency Tracking Number Assigned
TokenIdTypeStringMin length: 1
Max length: 2000
DUNSTypeStringAlphanumeric
Min length: 9
Max length: 13
FullNameTypeStringMin length: 1
Max length: 240
AORStatusTypeStringValid values:
Y
N
MessageCodeTypeStringNumeric
Min length: 2
Max length: 2
MessageTextTypeStringMin length: 1
Max length: 2000
AgencyContactInfoTypeStringMin length: 1
Max length: 2000
AgencyTrackingNumberTypeStringValid characters: spaces and non-whitespace characters Invalid: line feeds, tabs, carriage returns
AgencyNotesTypeStringMin length:1
Max length: 2048
StatusDetailTypeStringMin length:1
CompetitionIDTypeStringValid characters: Uppercase letters, numeric, and hyphens
Max length: 40

GrantsCommonElements-V1.0.xsd

The ‘Grants Common Elements’ schema is a new common schema 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 NameElement TypeElement RulesRequired / Optional
CompetitionIDGrantsCommonTypes: CompetitionIDType  
CompetitionTitleGrantsCommonTypes: CompetitionTitleType  
GrantsGovTrackingNumberGrantsCommonTypes: GrantsGovTrackingNumberType  
PostingDateGrantsCommonTypes: MMDDYYYYFwdSlashType  
FundingOpportunityNumberGrantsCommonTypes: FundingOpportunityNumberType  
UserIDGrantsCommonTypes: UserIDType  
FundingOpportunityTitleGrantsCommonTypes: StringWithoutNewLine255Type  
ClosingDateGrantsCommonTypes: MMDDYYYYFwdSlashType  
ArchiveDateGrantsCommonTypes: MMDDYYYYFwdSlashType  
CFDANumberGrantsCommonTypes: CFDANumberType  
SendChangeNotificationEmailStringValid values:
Y
N		 
ModificationCommentsStringMin length: 1
Max length:2000		 
CompetitionInfoComplex  
CompetitionIDGrantsCommonTypes: CompetitionIDType Required
CompetitionTitleGrantsCommonTypes: CompetitionTitleType Required
ResponseMessageStringValid values:
Success
Failure		 
InstructionFileInfoComplex  
FileNameGrantsCommonTypes: FileNameType Required
FileExtensionGrantsCommonTypes: FileExtensionType Required
FileContentIdGrantsCommonTypes: FileContentIdType Required
FileDataHandlerxs:base64Binary (streamed to the client)application/octet-streamRequired
AttachmentComplex  
FileContentIdGrantsCommonTypes: FileContentIdType Required
FileDataHandlerxs:base64Binary (streamed to the client)application/octet-streamRequired
ApplicationFilterComplex  
FilterStringValid values:
Status
OpportunityID
CFDANumber
SubmissionTitle
GrantsGovTrackingNumber		Optional
FilterValueStringValid ‘Status’ values:
Receiving
Received
Processing
Validated
Rejected with Errors
Received by Agency
Agency Tracking Number Assigned		Optional
FilterTypeStringValid values:
Status
OpportunityID
CFDANumber		Required
TokenComplex  
UserIDGrantsCommonTypes: UserIDType Required
TokenIdGrantsCommonTypes: TokenIdType Optional
DUNSGrantsCommonTypes: DUNSType Optional
FullNameGrantsCommonTypes: FullNameType Optional
AORStatusGrantsCommonTypes: AORStatusType Required
TokenExpirationdateTime Optional
SecurityMessageComplex  
MessageCodeGrantsCommonTypes: MessageCodeType Required
MessageTextGrantsCommonTypes: MessageTextType Required
ErrorDetailsComplex  
CodeGrantsCommonTypes: MessageCodeType Required
MessageGrantsCommonTypes: MessageTextType Required
AgencyTrackingNumberGrantsCommonTypes: StringMin1Max240Type  
SubmissionTitleGrantsCommonTypes: StringMin1Max240Type  
OfferingAgencyGrantsCommonTypes: StringMin1Max255Type  
GrantsGovApplicationStatusGrantsCommonTypes: GrantsGovApplicationStatusType  
AgencyContactInfoGrantsCommonTypes: AgencyContactInfoType  
CFDADescriptionGrantsCommonTypes: StringWithoutNewLine255Type  
SchemaURLGrantsCommonTypes: StringWithoutNewLine255Type  
InstructionsURLGrantsCommonTypes: StringWithoutNewLine255Type  
StatusDetailGrantsCommonTypes: StatusDetailType  
AgencyNotesGrantsCommonTypes: AgencyNotesType  
[TOP OF PAGE]

Quick Links

Latest News! Grants.gov Blog External Web Site Policy
FOR APPLICANTS
FOR GRANTORS

 
 

 

Policies & Disclaimers | FOIA | No FEAR Act | Accessibility | Viewers & Players | Contact Us | Help | Site Map
U.S. Dept. of Health and Human Services | USA.gov - Government Made Easy | WhiteHouse.gov
USASpending.gov | FSRS.gov | SAM.gov | DUNS Request External Web Site Policy | CFDA.gov | SBA.gov | Federal Student Aid