Grants Template
GrantsTemplate-V1.0.xsd
The 'Grants Template' schema is a new common schema 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:
https://trainingapply.grants.gov/apply/system/schemas/GrantsTemplate-V1.0.xsd
For the Production Environment, this schema is located at:
https://apply07.grants.gov/apply/system/schemas/GrantsTemplate-V1.0.xsd
Schema Elements
| Element Name / Sub-Element Name | Element Type | Element Rules | Required / Optional |
|---|---|---|---|
| CreateTemplate | Complex | ||
| TemplateName | GrantsTemplate: TemplateName | Required | |
| FormFamily | GrantsTemplate: FormFamily | Required | |
| TemplateType | GrantsTemplate: TemplateType | Optional | |
|
AgencyCode |
GrantsCommonElements: AgencyCode | Optional | |
| TemplateForm | GrantsTemplate: TemplateForm | Required (Multiple occurrences allowed) | |
| UpdateTemplate | Complex | ||
| TemplateID | GrantsTemplate: TemplateID | Required | |
| TemplateName | GrantsTemplate: TemplateName | Optional | |
| TemplateType | GrantsTemplate: TemplateType | Optional | |
| TemplateForm | GrantsTemplate: TemplateForm | Optional (Multiple occurrences allowed) | |
| DeleteTemplate | Complex | ||
| TemplateID | GrantsTemplate: TemplateID | Required | |
| TemplateForm | Complex | ||
| FormID | GrantsTemplate: FormID | Required | |
| FormType | GrantsTemplate: FormType | Required | |
| FormFilter | Complex | ||
| FormFamily | GrantsTemplate: FormFamily | Optional | |
| TemplateFilter | Complex | ||
| TemplateName | GrantsTemplate: TemplateName | Optional | |
|
AgencyCode |
GrantsCommonElements: AgencyCode | Optional | |
| FormFamily | GrantsTemplate: FormFamily | Optional | |
| ContainsFormID | GrantsTemplate: ContainsFormID | Optional | |
| TemplateType | GrantsTemplate: TemplateType | Optional (Max: 2 occurrences allowed) | |
| TemplateID | GrantsCommonTypes:Number15DigitsType | ||
| TemplateName | GrantsCommonTypes:TemplateNameType | ||
| TemplateType | GrantsTemplate: TemplateType | Default: SingleProject | |
| FormFamily | GrantsTemplate: FormFamilyType | ||
| FormID | GrantsCommonTypes:Number15DigitsType | ||
| ShortFormName | GrantsCommonTypes:StringMin1Max75Type | ||
| FormName | GrantsCommonTypes:StringMin1Max255Type | ||
| FormVersion | GrantsCommonTypes:StringMin1Max25Type | ||
| SchemaURL | GrantsCommonTypes:StringWithoutNewLine250Type | ||
| FormType | GrantsTemplate:TemplateFormType | ||
| Active | GrantsCommonTypes:YesNoType | ||
| ActiveFormID | GrantsCommonTypes:Number15DigitsType | ||
| ContainsInactiveForms | GrantsCommonTypes:YesNoType | ||
| LastUsedInPackageTimestamp | dateTime | ||
| ContainsFormID | GrantsCommonTypes:Number15DigitsType | ||
| TemplateType | String |
Valid values:
|
|
| TemplateFormType | String |
Valid values:
|
|
| FormFamilyType | String |
Valid values:
|
|
| TemplateDetails | Complex | ||
| TemplateName | GrantsTemplate: TemplateName | Optional | |
| TemplateID | GrantsTemplate: TemplateID | Optional | |
|
AgencyCode |
GrantsCommonElements: AgencyCode | Optional | |
| FormFamily | GrantsTemplate: FormFamily | Optional | |
| TemplateType | GrantsTemplate: TemplateType | Optional | |
| ContainsInactiveForms | GrantsTemplate: ContainsInactiveForms | Optional | |
|
LastUpdatedTimestamp |
GrantsCommonElements: LastUpdatedTimestamp | Optional | |
| LastUsedInPackageTimestamp | GrantsTemplate: LastUsedInPackageTimestamp | Optional | |
| TemplateFormDetails | GrantsTemplate: TemplateFormDetails | Optional (Multiple occurrences allowed) | |
| GrantFormDetails | Complex | ||
| FormID | GrantsTemplate: FormID | Optional | |
|
AgencyCode |
GrantsCommonElements: AgencyCode | Optional | |
| ShortFormName | GrantsTemplate: ShortFormName | Optional | |
| FormName | GrantsTemplate: FormName | Optional | |
| FormVersion | GrantsTemplate: FormVersion | Optional | |
| SchemaURL | GrantsTemplate: SchemaURL | Optional | |
| Active | GrantsTemplate: Active | Optional | |
| ActiveFormID | GrantsTemplate: ActiveFormID | Optional | |
| FormFamily | GrantsTemplate: FormFamily | Optional (Multiple occurrences allowed) | |
| TemplateFormDetails | Complex | ||
| FormID | GrantsTemplate: FormID |
Optional |
|
| FormType | GrantsTemplate: FormType | Optional |