Grants Related Document
GrantsRelatedDocument-V1.0.xsd
The 'Grants Related Document' 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/GrantsRelatedDocument-V1.0.xsd
For the Production Environment, this schema is located at:
https://apply07.grants.gov/apply/system/schemas/GrantsRelatedDocument-V1.0.xsd
Schema Elements
Element Name / Sub-Element Name | Element Type | Element Rules | Required / Optional |
---|---|---|---|
CreateFolder | Complex | ||
FolderName | GrantsRelatedDocument: FolderName | Required | |
FolderType | GrantsRelatedDocument: FolderType | Required | |
UpdateFolder | Complex | ||
FolderID | GrantsCommonElements: FolderID | Required | |
FolderName | GrantsRelatedDocument: FolderName | Optional | |
FolderType | GrantsRelatedDocument: FolderType | Optional | |
DeleteFolder | Complex | ||
FolderID | GrantsCommonElements: FolderID | Required | |
AddFile | Complex | ||
FileName | GrantsCommonElements: FileName | Required | |
FileDescription | GrantsRelatedDocument: FileDescription | Required | |
DataHandler | base64Binary | Required | |
FolderID | GrantsCommonElements: FolderID | Required | |
ReplaceFile | Complex | ||
FileID | GrantsCommonElements: FileID | Required | |
FileName | GrantsCommonElements: FileName | Optional | |
FileDescription | GrantsRelatedDocument: FileDescription | Optional | |
DataHandler | base64Binary | Optional | |
RemoveFile | Complex | ||
FileID | GrantsCommonElements: FileID | Required | |
CreateLink | Complex | ||
LinkURL | GrantsCommonElements: LinkURL | Required | |
LinkDescription | GrantsCommonElements: LinkDescription | Required | |
UpdateLink | Complex | ||
LinkID | GrantsCommonElements: LinkID | Required | |
LinkURL | GrantsCommonElements: LinkURL | Optional | |
LinkDescription | GrantsCommonElements: LinkDescription | Optional | |
DeleteLink | Complex | ||
LinkID | GrantsCommonElements: LinkID | Required | |
FolderName | GrantsCommonTypes: StringMin1Max30Type | ||
FileDescription | GrantsCommonTypes: StringWithoutNewLine250Type | ||
FolderType | GrantsRelatedDocument: FolderType | Valid values:
FULL_ANNOUNCEMENT REVISED_FULL_ANNOUNCEMENT OTHER_SUPPORTING_DOCUMENTS |
|
FileDetails | Complex | ||
FileID | GrantsCommonElements: FileID | Optional | |
FileName | GrantsCommonElements: FileName | Optional | |
FileDescription | GrantsRelatedDocument: FileDescription | Optional | |
FileMIMEType | GrantsCommonElements: FileMIMEType | Optional | |
FileSizeInKB | GrantsCommonElements: FileSizeInKB | Optional | |
LastUpdatedTimestamp | GrantsCommonElements: LastUpdatedTimestamp | Optional | |
FileDataHandler | base64Binary | Optional | |
FolderDetails | Complex | ||
FolderID | GrantsCommonElements: FolderID | Optional | |
FolderType | GrantsRelatedDocument: FolderType | Optional | |
FolderName | GrantsRelatedDocument: FolderName | Optional | |
LastUpdatedTimestamp | GrantsCommonElements: LastUpdatedTimestamp | Optional | |
FolderAndFileDetails | Complex | ||
FolderID | GrantsCommonElements: FolderID | Optional | |
FolderType | GrantsRelatedDocument: FolderType | Optional | |
FolderName | GrantsRelatedDocument: FolderName | Optional | |
LastUpdatedTimestamp | GrantsCommonElements: LastUpdatedTimestamp | Optional | |
FileDetails | GrantsRelatedDocument: FileDetails | Optional (Multiple occurrences allowed) | |
LinkDetails | Complex | ||
LinkID | GrantsCommonElements: LinkID | Optional | |
LinkURL | GrantsCommonElements: LinkURL | Optional | |
LinkDescription | GrantsCommonElements: LinkDescription | Optional | |
LastUpdatedTimestamp | GrantsCommonElements: LastUpdatedTimestamp | Optional | |
RelatedDocumentDetails | Complex | ||
LinkDetails | GrantsRelatedDocument: LinkDetails | Optional (Multiple occurrences allowed) | |
FolderAndFileDetails | GrantsRelatedDocument: FolderAndFileDetails | Optional (Multiple occurrences allowed) | |
AddFileResult | Complex | ||
Success | Boolean | Required | |
FolderID | GrantsCommonElements: FolderID | Optional | |
FileDetails | GrantsRelatedDocument: FileDetails | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
ReplaceFileResult | Complex | ||
Success | Boolean | Required | |
FileDetails | GrantsRelatedDocument: FileDetails | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
RemoveFileResult | Complex | ||
Success | Boolean | Required | |
FileID | GrantsCommonElements: FileID | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
CreateLinkResult | Complex | ||
Success | Boolean | Required | |
LinkDetails | GrantsRelatedDocument: LinkDetails | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
UpdateLinkResult | Complex | ||
Success | Boolean | Required | |
LinkDetails | GrantsRelatedDocument: LinkDetails | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
DeleteLinkResult | Complex | ||
Success | Boolean | Required | |
LinkID | GrantsCommonElements: LinkID | Required | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
CreateFolderResult | Complex | ||
Success | Boolean | Required | |
FolderDetails | GrantsRelatedDocument: FolderDetails | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
UpdateFolderResult | Complex | ||
Success | Boolean | Required | |
FolderDetails | GrantsRelatedDocument: FolderDetails | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) | |
DeleteFolderResult | Complex | ||
Success | Boolean | Required | |
FolderID | GrantsCommonElements: FolderID | Optional | |
ErrorDetails | GrantsCommonElements: ErrorDetails | Optional (Multiple occurrences allowed) |