POST api/Villages

Create a Village

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FirstName	First name of the person for whom the village is being created	string	Required String length: inclusive between 0 and 120
LastName	Last name of the person for whom the village is being created	string	Required String length: inclusive between 0 and 120
Name	Name of the Village (FirstName + LastName)	string	None.
DOB	Date of Birth of the person being taken care of	date	Data type: Date
Address	Primary address of the person being taken care of	OptionalAddressModel	None.
TimeZone	Time Zone of the Village (Care Recipient)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample",
  "LastName": "string 3",
  "Name": "sample string 3",
  "DOB": "2025-06-03",
  "Address": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "Zip": "sample string 5",
    "Country": "sample string 6"
  },
  "TimeZone": "sample string 4"
}

application/xml, text/xml

Sample:

<VillageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zip>sample string 5</d2p1:Zip>
  </Address>
  <DOB>2025-06-03T04:13:07.6727029+00:00</DOB>
  <FirstName>sample</FirstName>
  <LastName>string 3</LastName>
  <Name>sample string 3</Name>
  <TimeZone>sample string 4</TimeZone>
</VillageModel>

multipart/form-data

Sample:

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

Response Information

Resource Description

VillageViewModel

Name	Description	Type	Additional information
Id	The unique ID of this Village:Villager mapping (For invitations, this is the Invitation ID)	globally unique identifier	None.
VillageId	Village's Unique ID	globally unique identifier	None.
VillagerId	Villager's Unique ID (For invitations, this will always be Guid.Empty)	globally unique identifier	None.
Members	Number of members in the village	integer	None.
Role	User's role in the village	UserVillageRole	None.
RoleName	User's role in the village, long form	string	None.
Features	The features which are enabled for the village	VillageFeatures	None.
OwnerId	Village Owner's ID	globally unique identifier	None.
IsDemoVillage	If true, the village is a demo village and can be reset	boolean	None.
BusinessId	For business villages, the ID of the business	globally unique identifier	None.
BusinessName	For Business villages, the name of the business	string	None.
BusinessRole	For business villages, the role of the user in the business	BusinessUserRole	None.
CandidateId	If exists, is the ID of the user asked to be the new village owner	globally unique identifier	None.
TransferRequest	The associated trasnfer request, if any	TransferRequestModel	None.
TotalFileSize	Total size of all documents/attachments in the village	integer	None.
Subscription	Village subscription details (from User subscription)	VillageSubscriptionModel	None.
Created	Date/Time the village was created	date	None.
Updated	Date/Time the primary village record was last updated	date	None.
FirstName	First name of the person for whom the village is being created	string	Required String length: inclusive between 0 and 120
LastName	Last name of the person for whom the village is being created	string	Required String length: inclusive between 0 and 120
Name	Name of the Village (FirstName + LastName)	string	None.
DOB	Date of Birth of the person being taken care of	date	Data type: Date
Address	Primary address of the person being taken care of	OptionalAddressModel	None.
TimeZone	Time Zone of the Village (Care Recipient)	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "6b6960b4-ab79-4c1c-9615-ebfc4bfc684b",
  "VillageId": "f4039d24-4e96-42d1-ac23-fe41e08b9d34",
  "VillagerId": "0793770b-f94e-42ff-8576-3854300b51ee",
  "Members": 4,
  "Role": 0,
  "RoleName": "Revoked",
  "Features": 0,
  "OwnerId": "fc961fa8-aae1-4dd7-9c30-580c59b9759e",
  "IsDemoVillage": true,
  "BusinessId": "51f2d4c8-cd61-4a10-b56e-64f0f10ffcd6",
  "BusinessName": "sample string 7",
  "BusinessRole": 1,
  "CandidateId": "37db7868-b4eb-48c9-ba06-6fa4b7795c10",
  "TransferRequest": {
    "Id": "66ff139a-7928-448c-acd7-9e5791cff16f",
    "CandidateId": "b600618d-949f-4230-b5f1-3335f842a5b3",
    "Candidate": "sample string 3",
    "RequestedBy": "sample string 4",
    "VillageId": "f606ea36-36ed-45d1-8745-8d7d8b96e719",
    "VillageName": "sample string 6"
  },
  "TotalFileSize": 8,
  "Subscription": {
    "MaxFileSize": 1,
    "MaxStorage": 2,
    "MaxJournalPhotos": 3,
    "PremiumFeatures": 0,
    "Cancelled": true,
    "SubscriptionStartDate": "2025-06-03T04:13:07.688+00:00",
    "ExpirationDate": "2025-06-03T04:13:07.688+00:00",
    "Expired": false,
    "MaxVillagers": 7
  },
  "Created": "2025-06-03T04:13:07.688+00:00",
  "Updated": "2025-06-03T04:13:07.688+00:00",
  "FirstName": "sample",
  "LastName": "string 13",
  "Name": "sample string 13",
  "DOB": "2025-06-03",
  "Address": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "Zip": "sample string 5",
    "Country": "sample string 6"
  },
  "TimeZone": "sample string 14"
}

application/xml, text/xml

Sample:

<VillageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:Zip>sample string 5</d2p1:Zip>
  </Address>
  <DOB>2025-06-03T04:13:07.6883962+00:00</DOB>
  <FirstName>sample</FirstName>
  <LastName>string 13</LastName>
  <Name>sample string 13</Name>
  <TimeZone>sample string 14</TimeZone>
  <BusinessId>51f2d4c8-cd61-4a10-b56e-64f0f10ffcd6</BusinessId>
  <BusinessName>sample string 7</BusinessName>
  <BusinessRole>Client</BusinessRole>
  <CandidateId>37db7868-b4eb-48c9-ba06-6fa4b7795c10</CandidateId>
  <Created>2025-06-03T04:13:07.6883962+00:00</Created>
  <Features>None</Features>
  <Id>6b6960b4-ab79-4c1c-9615-ebfc4bfc684b</Id>
  <IsDemoVillage>true</IsDemoVillage>
  <Members>4</Members>
  <OwnerId>fc961fa8-aae1-4dd7-9c30-580c59b9759e</OwnerId>
  <Role>Revoked</Role>
  <Subscription>
    <Cancelled>true</Cancelled>
    <ExpirationDate>2025-06-03T04:13:07.6883962+00:00</ExpirationDate>
    <MaxFileSize>1</MaxFileSize>
    <MaxJournalPhotos>3</MaxJournalPhotos>
    <MaxStorage>2</MaxStorage>
    <MaxVillagers>7</MaxVillagers>
    <PremiumFeatures>None</PremiumFeatures>
    <SubscriptionStartDate>2025-06-03T04:13:07.6883962+00:00</SubscriptionStartDate>
  </Subscription>
  <TotalFileSize>8</TotalFileSize>
  <TransferRequest>
    <Candidate>sample string 3</Candidate>
    <CandidateId>b600618d-949f-4230-b5f1-3335f842a5b3</CandidateId>
    <Id>66ff139a-7928-448c-acd7-9e5791cff16f</Id>
    <RequestedBy>sample string 4</RequestedBy>
    <VillageId>f606ea36-36ed-45d1-8745-8d7d8b96e719</VillageId>
    <VillageName>sample string 6</VillageName>
  </TransferRequest>
  <Updated>2025-06-03T04:13:07.6883962+00:00</Updated>
  <VillageId>f4039d24-4e96-42d1-ac23-fe41e08b9d34</VillageId>
  <VillagerId>0793770b-f94e-42ff-8576-3854300b51ee</VillagerId>
</VillageViewModel>