GRANTS COMMON ELEMENTS
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:
https://trainingapply.grants.gov/apply/system/schemas/GrantsCommonElements-V1.0.xsd
For the Production Environment, this schema is located at:
https://apply07.grants.gov/apply/system/schemas/GrantsCommonElements-V1.0.xsd
Schema Elements
| Element / Sub-Element Name | Element Type | Element Rules | Required/ Optional |
|---|---|---|---|
| UEI | GrantsCommonTypes: UEIType | ||
| AORStatus | GrantsCommonTypes: AORStatusType | ||
| AORUserFullName | GrantsCommonTypes: FullNameType | ||
| DUNS | GrantsCommonTypes: DUNSType | ||
| ActiveExclusions | GrantsCommonTypes: ActiveExclusionsType | ||
| DelinquentFederalDebt | GrantsCommonTypes: DelinquentFederalDebtType | ||
| ExpandedApplicationFilter | String |
Valid values:
|
|
| Version | String | ||
| FolderID | GrantsCommonTypes: Number18DigitType | ||
| FileID | GrantsCommonTypes: Number18DigitType | ||
| LinkID | GrantsCommonTypes: Number18DigitType | ||
| OpportunityID | GrantsCommonTypes: Number18DigitType | ||
| PackageID | GrantsCommonTypes: PackageIDType | ||
| LinkURL | GrantsCommonTypes: StringWithoutNewLine250Type | ||
| LinkDescription | GrantsCommonTypes: StringWithoutNewLine250Type | ||
| LastUpdatedTimestamp | dateTime | ||
| InstructionFileLastUpdatedTimestamp | dateTime | ||
| CompletionStatus | GrantsCommonTypes: OperationStatusType | ||
| FileSizeInKB | GrantsCommonTypes: Number8DigitType | ||
| FileName | GrantsCommonTypes: StringMin1Max255Type | ||
| FileMIMEType | GrantsCommonTypes: StringWithoutNewLine512Type | ||
| AgencyCode | GrantsCommonTypes: StringMin1Max255Type | ||
| AgencyName | GrantsCommonTypes: StringMin1Max255Type | ||
| SubmissionMethod | GrantsCommonTypes: SubmissionMethodType | ||
| OpportunityCategoryExplanation | GrantsCommonTypes: StringMin1Max255Type | ||
| NullifyMissingOptionalElements | GrantsCommonTypes: YesNoType | Default: N | |
| SendUpdateNotificationEmail | GrantsCommonTypes: YesNoType | Default: Y | |
| UpdateComments | GrantsCommonTypes: StringMin1Max2000Type | ||
| SendDeleteNotificationEmail | GrantsCommonTypes: YesNoType | Default: Y | |
| DeleteComments | GrantsCommonTypes: StringMin1Max2000Type | ||
| NumberOfNotificationsSent | GrantsCommonTypes: Number8DigitType | ||
| LastUpdatedTimestampRangeFilter | Complex | ||
| BeginValue | dateTime | Optional | |
| EndValue | dateTime | Optional | |
| CompetitionID | GrantsCommonTypes: CompetitionIDType | ||
| CompetitionTitle | GrantsCommonTypes: CompetitionTitleType | ||
| GrantsGovTrackingNumber | GrantsCommonTypes: GrantsGovTrackingNumberType | ||
| PreviousGrantsGovTrackingNumber | GrantsCommonTypes: GrantsGovTrackingNumberType | ||
| PostingDate | GrantsCommonTypes: MMDDYYYYFwdSlashType | ||
| FundingOpportunityNumber | GrantsCommonTypes: FundingOpportunityNumberType | ||
| UserID | GrantsCommonTypes: UserIDType | ||
| FundingOpportunityTitle | GrantsCommonTypes: StringWithoutNewLine255Type | ||
| ClosingDate | GrantsCommonTypes: MMDDYYYYFwdSlashType | ||
| ArchiveDate | GrantsCommonTypes: MMDDYYYYFwdSlashType | ||
| CFDANumber | GrantsCommonTypes: CFDANumberType | ||
| OpportunityCategory |
GrantsCommonTypes: OpportunityCategoryType |
Valid values:
|
Optional |
| OtherOpportunityCategoryExplanation |
String | Max length:255 | Optional |
| SendChangeNotificationEmail | String | Valid values:
|
|
| ModificationComments | String | Min length: 1 Max length:2000 |
|
| CompetitionInfo | Complex | ||
| CompetitionID | GrantsCommonTypes: CompetitionIDType | Required | |
| CompetitionTitle | GrantsCommonTypes: CompetitionTitleType | Required | |
| ResponseMessage | String | Valid values:
|
|
| InstructionFileInfo | Complex | ||
| FileName | GrantsCommonTypes: FileNameType | Required | |
| FileExtension | GrantsCommonTypes: FileExtensionType | Required | |
| FileContentId | GrantsCommonTypes: FileContentIdType | Required | |
| FileDataHandler | base64Binary (streamed to the client) | application/octet-stream | Required |
| Attachment | Complex | ||
| FileContentId | GrantsCommonTypes: FileContentIdType | Required | |
| FileDataHandler | base64Binary (streamed to the client) | application/octet-stream | Required |
| ApplicationFilter | Complex | ||
| Filter | String | Valid values:
|
Optional |
| FilterValue | String | Valid "Status" values:
|
Optional |
| FilterType | String | Valid values:
|
Optional |
| 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 | |
| TokenInfo | Complex | ||
| TokenId | GrantsCommonTypes: TokenIdType | Optional | |
| TokenExpirationDate | dateTime | Optional | |
| SecurityMessage | Complex | ||
| MessageCode | GrantsCommonTypes: MessageCodeType | Required | |
| MessageText | GrantsCommonTypes: MessageTextType | Required | |
| ErrorDetails | Complex | ||
| Code | String | Required | |
| Message | String | Optional | |
| 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 |