GET api/Villages?withExpired={withExpired}&lastUpdated={lastUpdated}

Get a list of all villages the user is a member of

Request Information

URI Parameters

NameDescriptionTypeAdditional information
withExpired

boolean

Default value is False
lastUpdated

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of VillageViewModel
NameDescriptionTypeAdditional 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": "cf6de98b-a8ab-48eb-b7bb-8f841c4330e4",
    "VillageId": "c5438db0-40d9-4e91-a470-df2de66a8d96",
    "VillagerId": "77ad460c-307b-413a-b420-61f8e6e8ee2a",
    "Members": 4,
    "Role": 0,
    "RoleName": "Revoked",
    "Features": 0,
    "OwnerId": "686fffac-4d6c-4291-b85b-c7dcd50a921d",
    "IsDemoVillage": true,
    "BusinessId": "9e9449c5-9e68-4634-a06a-152d56099c69",
    "BusinessName": "sample string 7",
    "BusinessRole": 1,
    "CandidateId": "6233e282-8a5e-454b-83ba-c5481818ea94",
    "TransferRequest": {
      "Id": "275bb681-cdbe-4209-b42c-6c7fafc59086",
      "CandidateId": "40ef9ed8-ac82-4edd-b05d-6b4d281c3e98",
      "Candidate": "sample string 3",
      "RequestedBy": "sample string 4",
      "VillageId": "c3a18ac5-af15-4758-b662-520babe86803",
      "VillageName": "sample string 6"
    },
    "TotalFileSize": 8,
    "Subscription": {
      "MaxFileSize": 1,
      "MaxStorage": 2,
      "MaxJournalPhotos": 3,
      "PremiumFeatures": 0,
      "Cancelled": true,
      "SubscriptionStartDate": "2025-06-03T04:22:15.249+00:00",
      "ExpirationDate": "2025-06-03T04:22:15.249+00:00",
      "Expired": false,
      "MaxVillagers": 7
    },
    "Created": "2025-06-03T04:22:15.249+00:00",
    "Updated": "2025-06-03T04:22:15.249+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"
  },
  {
    "Id": "cf6de98b-a8ab-48eb-b7bb-8f841c4330e4",
    "VillageId": "c5438db0-40d9-4e91-a470-df2de66a8d96",
    "VillagerId": "77ad460c-307b-413a-b420-61f8e6e8ee2a",
    "Members": 4,
    "Role": 0,
    "RoleName": "Revoked",
    "Features": 0,
    "OwnerId": "686fffac-4d6c-4291-b85b-c7dcd50a921d",
    "IsDemoVillage": true,
    "BusinessId": "9e9449c5-9e68-4634-a06a-152d56099c69",
    "BusinessName": "sample string 7",
    "BusinessRole": 1,
    "CandidateId": "6233e282-8a5e-454b-83ba-c5481818ea94",
    "TransferRequest": {
      "Id": "275bb681-cdbe-4209-b42c-6c7fafc59086",
      "CandidateId": "40ef9ed8-ac82-4edd-b05d-6b4d281c3e98",
      "Candidate": "sample string 3",
      "RequestedBy": "sample string 4",
      "VillageId": "c3a18ac5-af15-4758-b662-520babe86803",
      "VillageName": "sample string 6"
    },
    "TotalFileSize": 8,
    "Subscription": {
      "MaxFileSize": 1,
      "MaxStorage": 2,
      "MaxJournalPhotos": 3,
      "PremiumFeatures": 0,
      "Cancelled": true,
      "SubscriptionStartDate": "2025-06-03T04:22:15.249+00:00",
      "ExpirationDate": "2025-06-03T04:22:15.249+00:00",
      "Expired": false,
      "MaxVillagers": 7
    },
    "Created": "2025-06-03T04:22:15.249+00:00",
    "Updated": "2025-06-03T04:22:15.249+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: 
<ArrayOfVillageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <VillageViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <DOB>2025-06-03T04:22:15.2498233+00:00</DOB>
    <FirstName>sample</FirstName>
    <LastName>string 13</LastName>
    <Name>sample string 13</Name>
    <TimeZone>sample string 14</TimeZone>
    <BusinessId>9e9449c5-9e68-4634-a06a-152d56099c69</BusinessId>
    <BusinessName>sample string 7</BusinessName>
    <BusinessRole>Client</BusinessRole>
    <CandidateId>6233e282-8a5e-454b-83ba-c5481818ea94</CandidateId>
    <Created>2025-06-03T04:22:15.2498233+00:00</Created>
    <Features>None</Features>
    <Id>cf6de98b-a8ab-48eb-b7bb-8f841c4330e4</Id>
    <IsDemoVillage>true</IsDemoVillage>
    <Members>4</Members>
    <OwnerId>686fffac-4d6c-4291-b85b-c7dcd50a921d</OwnerId>
    <Role>Revoked</Role>
    <Subscription>
      <Cancelled>true</Cancelled>
      <ExpirationDate>2025-06-03T04:22:15.2498233+00:00</ExpirationDate>
      <MaxFileSize>1</MaxFileSize>
      <MaxJournalPhotos>3</MaxJournalPhotos>
      <MaxStorage>2</MaxStorage>
      <MaxVillagers>7</MaxVillagers>
      <PremiumFeatures>None</PremiumFeatures>
      <SubscriptionStartDate>2025-06-03T04:22:15.2498233+00:00</SubscriptionStartDate>
    </Subscription>
    <TotalFileSize>8</TotalFileSize>
    <TransferRequest>
      <Candidate>sample string 3</Candidate>
      <CandidateId>40ef9ed8-ac82-4edd-b05d-6b4d281c3e98</CandidateId>
      <Id>275bb681-cdbe-4209-b42c-6c7fafc59086</Id>
      <RequestedBy>sample string 4</RequestedBy>
      <VillageId>c3a18ac5-af15-4758-b662-520babe86803</VillageId>
      <VillageName>sample string 6</VillageName>
    </TransferRequest>
    <Updated>2025-06-03T04:22:15.2498233+00:00</Updated>
    <VillageId>c5438db0-40d9-4e91-a470-df2de66a8d96</VillageId>
    <VillagerId>77ad460c-307b-413a-b420-61f8e6e8ee2a</VillagerId>
  </VillageViewModel>
  <VillageViewModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <DOB>2025-06-03T04:22:15.2498233+00:00</DOB>
    <FirstName>sample</FirstName>
    <LastName>string 13</LastName>
    <Name>sample string 13</Name>
    <TimeZone>sample string 14</TimeZone>
    <BusinessId>9e9449c5-9e68-4634-a06a-152d56099c69</BusinessId>
    <BusinessName>sample string 7</BusinessName>
    <BusinessRole>Client</BusinessRole>
    <CandidateId>6233e282-8a5e-454b-83ba-c5481818ea94</CandidateId>
    <Created>2025-06-03T04:22:15.2498233+00:00</Created>
    <Features>None</Features>
    <Id>cf6de98b-a8ab-48eb-b7bb-8f841c4330e4</Id>
    <IsDemoVillage>true</IsDemoVillage>
    <Members>4</Members>
    <OwnerId>686fffac-4d6c-4291-b85b-c7dcd50a921d</OwnerId>
    <Role>Revoked</Role>
    <Subscription>
      <Cancelled>true</Cancelled>
      <ExpirationDate>2025-06-03T04:22:15.2498233+00:00</ExpirationDate>
      <MaxFileSize>1</MaxFileSize>
      <MaxJournalPhotos>3</MaxJournalPhotos>
      <MaxStorage>2</MaxStorage>
      <MaxVillagers>7</MaxVillagers>
      <PremiumFeatures>None</PremiumFeatures>
      <SubscriptionStartDate>2025-06-03T04:22:15.2498233+00:00</SubscriptionStartDate>
    </Subscription>
    <TotalFileSize>8</TotalFileSize>
    <TransferRequest>
      <Candidate>sample string 3</Candidate>
      <CandidateId>40ef9ed8-ac82-4edd-b05d-6b4d281c3e98</CandidateId>
      <Id>275bb681-cdbe-4209-b42c-6c7fafc59086</Id>
      <RequestedBy>sample string 4</RequestedBy>
      <VillageId>c3a18ac5-af15-4758-b662-520babe86803</VillageId>
      <VillageName>sample string 6</VillageName>
    </TransferRequest>
    <Updated>2025-06-03T04:22:15.2498233+00:00</Updated>
    <VillageId>c5438db0-40d9-4e91-a470-df2de66a8d96</VillageId>
    <VillagerId>77ad460c-307b-413a-b420-61f8e6e8ee2a</VillagerId>
  </VillageViewModel>
</ArrayOfVillageViewModel>