PUT api/Village/{village}/Folder/{id}

Update (e.g. rename) a document folder in a village

Request Information

URI Parameters

Name	Description	Type	Additional information
village		string	None.
id		string	None.

Body Parameters

VillageDocumentFolderUpdateModel

Name	Description	Type	Additional information
Id	Folder ID	globally unique identifier	None.
Name	Folder Name	string	None.
Description	Folder Description	string	None.
ParentFolderId	Parent Folder ID (if sub-folder)	globally unique identifier	None.
FolderType	What types of things can be added to this folder	DocumentFolderType	None.
Sequence	What order the folder should appear in, if not alphabetical (system folders are in specific order)	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "071ea96d-248c-4613-ad20-95ee84daffe4",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ParentFolderId": "45fb709c-8296-4966-be64-1da06bfb8d75",
  "FolderType": 1,
  "Sequence": 4
}

application/xml, text/xml

Sample:

<VillageDocumentFolderUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Description>sample string 3</Description>
  <FolderType>Files</FolderType>
  <Name>sample string 2</Name>
  <ParentFolderId>45fb709c-8296-4966-be64-1da06bfb8d75</ParentFolderId>
  <Sequence>4</Sequence>
  <Id>071ea96d-248c-4613-ad20-95ee84daffe4</Id>
</VillageDocumentFolderUpdateModel>

multipart/form-data

Sample:

Failed to generate the sample for media type 'multipart/form-data'. Cannot use formatter 'MultipartMediaTypeFormatter' to write type 'VillageDocumentFolderUpdateModel'.

Response Information

Resource Description

VillageDocumentFolderModel

Name	Description	Type	Additional information
IsDefault	True if the folder is a default (system-defined) folder, false if it's a user-created folder	boolean	None.
Created	DateTime the folder was created	date	None.
LinkCount	# of Links in the folder	integer	None.
FileCount	# of Documents in the folder	integer	None.
VillageId	Village ID	globally unique identifier	None.
Id	Folder ID	globally unique identifier	None.
Name	Folder Name	string	None.
Description	Folder Description	string	None.
ParentFolderId	Parent Folder ID (if sub-folder)	globally unique identifier	None.
FolderType	What types of things can be added to this folder	DocumentFolderType	None.
Sequence	What order the folder should appear in, if not alphabetical (system folders are in specific order)	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "IsDefault": true,
  "Created": "2025-06-03T05:05:59.406+00:00",
  "LinkCount": 3,
  "FileCount": 4,
  "VillageId": "f106bf40-ad84-42b0-ae7a-d38bd607763b",
  "Id": "1f3e5fc5-cdfd-4449-88f1-3a1f2eb7ca74",
  "Name": "sample string 7",
  "Description": "sample string 8",
  "ParentFolderId": "94b74e09-8b6d-4e81-9462-f9b34ea30596",
  "FolderType": 1,
  "Sequence": 9
}

application/xml, text/xml

Sample:

<VillageDocumentFolderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Description>sample string 8</Description>
  <FolderType>Files</FolderType>
  <Name>sample string 7</Name>
  <ParentFolderId>94b74e09-8b6d-4e81-9462-f9b34ea30596</ParentFolderId>
  <Sequence>9</Sequence>
  <Id>1f3e5fc5-cdfd-4449-88f1-3a1f2eb7ca74</Id>
  <Created>2025-06-03T05:05:59.4060787+00:00</Created>
  <FileCount>4</FileCount>
  <IsDefault>true</IsDefault>
  <LinkCount>3</LinkCount>
  <VillageId>f106bf40-ad84-42b0-ae7a-d38bd607763b</VillageId>
</VillageDocumentFolderModel>