GET api/Village/{village}/Documents?lastUpdated={lastUpdated}

Get all documents

Request Information

URI Parameters

Name	Description	Type	Additional information
lastUpdated		date	None.
village		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of VillageDocumentModel

Name	Description	Type	Additional information
Id	Unique ID of the document	globally unique identifier	None.
CategoryId	ID of the document Category [Obsolete("Replaced with Folders; retained for backwards compatibility")]	globally unique identifier	None.
CategorySequence	Display sequence for the category [Obsolete("Replaced with Folders; retained for backwards compatibility")]	integer	None.
CategoryName	Name of the Category [Obsolete("Replaced with Folders; retained for backwards compatibility")]	string	None.
ContentType	Document's MIME Content Type	string	None.
FileName	Document's original filename	string	None.
SortName	The file name for sorting purposes - uses DisplayName if available else FileName	string	None.
FileType	File Type description	string	None.
Icon	CSS class(es) to use for icon	string	None.
Uploaded	Date/Time the file was most recently uploaded/updated	date	None.
UploadedBy	Name of the user who most recently uploaded/updated the file	string	None.
UploadedById	Unique ID of the user who most recently uploaded/updated the file	globally unique identifier	None.
Size	The file's size, in bytes	integer	None.
DisplayName	The file's Display Name / Title	string	None.
VillageId	The ID of the village in which the document was uploaded	globally unique identifier	None.
FolderId	Folder ID of the folder to which the document belongs	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "5d53f9fe-79cb-47ce-9fb7-fc2a514869d9",
    "CategoryId": "6824b9f4-936f-473e-9bf5-e048f652ecf2",
    "CategorySequence": 1,
    "CategoryName": "sample string 2",
    "ContentType": "sample string 3",
    "FileName": "sample string 4",
    "SortName": "sample string 5",
    "FileType": "sample string 6",
    "Icon": "sample string 7",
    "Uploaded": "2025-06-03T04:41:25.537+00:00",
    "UploadedBy": "sample string 9",
    "UploadedById": "5e112169-258b-4d13-813b-4bee4a2be372",
    "Size": 11,
    "DisplayName": "sample string 12",
    "VillageId": "3e711d6b-2620-41e6-affb-4e58f720ba40",
    "FolderId": "1b0b6db4-f17d-49ba-b085-1020f251305d"
  },
  {
    "Id": "5d53f9fe-79cb-47ce-9fb7-fc2a514869d9",
    "CategoryId": "6824b9f4-936f-473e-9bf5-e048f652ecf2",
    "CategorySequence": 1,
    "CategoryName": "sample string 2",
    "ContentType": "sample string 3",
    "FileName": "sample string 4",
    "SortName": "sample string 5",
    "FileType": "sample string 6",
    "Icon": "sample string 7",
    "Uploaded": "2025-06-03T04:41:25.537+00:00",
    "UploadedBy": "sample string 9",
    "UploadedById": "5e112169-258b-4d13-813b-4bee4a2be372",
    "Size": 11,
    "DisplayName": "sample string 12",
    "VillageId": "3e711d6b-2620-41e6-affb-4e58f720ba40",
    "FolderId": "1b0b6db4-f17d-49ba-b085-1020f251305d"
  }
]

application/xml, text/xml

Sample:

<ArrayOfVillageDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <VillageDocumentModel>
    <CategoryId>6824b9f4-936f-473e-9bf5-e048f652ecf2</CategoryId>
    <CategoryName>sample string 2</CategoryName>
    <CategorySequence>1</CategorySequence>
    <ContentType>sample string 3</ContentType>
    <DisplayName>sample string 12</DisplayName>
    <FileName>sample string 4</FileName>
    <FileType>sample string 6</FileType>
    <FolderId>1b0b6db4-f17d-49ba-b085-1020f251305d</FolderId>
    <Icon>sample string 7</Icon>
    <Id>5d53f9fe-79cb-47ce-9fb7-fc2a514869d9</Id>
    <Size>11</Size>
    <SortName>sample string 5</SortName>
    <Uploaded>2025-06-03T04:41:25.5376887+00:00</Uploaded>
    <UploadedBy>sample string 9</UploadedBy>
    <UploadedById>5e112169-258b-4d13-813b-4bee4a2be372</UploadedById>
    <VillageId>3e711d6b-2620-41e6-affb-4e58f720ba40</VillageId>
  </VillageDocumentModel>
  <VillageDocumentModel>
    <CategoryId>6824b9f4-936f-473e-9bf5-e048f652ecf2</CategoryId>
    <CategoryName>sample string 2</CategoryName>
    <CategorySequence>1</CategorySequence>
    <ContentType>sample string 3</ContentType>
    <DisplayName>sample string 12</DisplayName>
    <FileName>sample string 4</FileName>
    <FileType>sample string 6</FileType>
    <FolderId>1b0b6db4-f17d-49ba-b085-1020f251305d</FolderId>
    <Icon>sample string 7</Icon>
    <Id>5d53f9fe-79cb-47ce-9fb7-fc2a514869d9</Id>
    <Size>11</Size>
    <SortName>sample string 5</SortName>
    <Uploaded>2025-06-03T04:41:25.5376887+00:00</Uploaded>
    <UploadedBy>sample string 9</UploadedBy>
    <UploadedById>5e112169-258b-4d13-813b-4bee4a2be372</UploadedById>
    <VillageId>3e711d6b-2620-41e6-affb-4e58f720ba40</VillageId>
  </VillageDocumentModel>
</ArrayOfVillageDocumentModel>