GET api/Village/{village}/Members
Get a list of villagers for the specified village
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
village | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of VillagerModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique ID of this village:villager mapping |
globally unique identifier |
None. |
VillageId |
Village's unique ID |
globally unique identifier |
None. |
VillagerId |
Villager's unique ID |
globally unique identifier |
None. |
FirstName |
Villager's first name |
string |
None. |
LastName |
Villager's last name |
string |
None. |
LastActivity |
Last time the villager was active |
date |
None. |
Role |
Villager's role in the village |
UserVillageRole |
None. |
RoleName |
User's role in the village, long form |
string |
None. |
Villager's email address |
string |
None. |
|
AvatarUrl |
URL for the villager's avatar, if any (null = use default avatar) |
string |
None. |
PhoneNumber |
Villager's Phone Number |
string |
None. |
Address |
Villager's Address |
AddressModel |
None. |
Joined | date |
None. |
|
LastActive | date |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "36f450f4-f80a-429c-8fbf-a4693a91b13b", "VillageId": "56abb24b-1ff4-47d7-bcad-d8bb6fa25c3b", "VillagerId": "d87d221a-8873-4c92-af1d-eb273645f7bd", "FirstName": "sample string 4", "LastName": "sample string 5", "LastActivity": "2025-06-03T04:41:26.490+00:00", "Role": 0, "RoleName": "Revoked", "Email": "sample string 6", "AvatarUrl": "sample string 7", "PhoneNumber": "sample string 8", "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" }, "Joined": "2025-06-03T04:41:26.490+00:00", "LastActive": "2025-06-03T04:41:26.490+00:00" }, { "Id": "36f450f4-f80a-429c-8fbf-a4693a91b13b", "VillageId": "56abb24b-1ff4-47d7-bcad-d8bb6fa25c3b", "VillagerId": "d87d221a-8873-4c92-af1d-eb273645f7bd", "FirstName": "sample string 4", "LastName": "sample string 5", "LastActivity": "2025-06-03T04:41:26.490+00:00", "Role": 0, "RoleName": "Revoked", "Email": "sample string 6", "AvatarUrl": "sample string 7", "PhoneNumber": "sample string 8", "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" }, "Joined": "2025-06-03T04:41:26.490+00:00", "LastActive": "2025-06-03T04:41:26.490+00:00" } ]
application/xml, text/xml
Sample:
<ArrayOfVillagerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <VillagerModel> <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> <AvatarUrl>sample string 7</AvatarUrl> <Email>sample string 6</Email> <FirstName>sample string 4</FirstName> <Id>36f450f4-f80a-429c-8fbf-a4693a91b13b</Id> <Joined>2025-06-03T04:41:26.4907723+00:00</Joined> <LastActive>2025-06-03T04:41:26.4907723+00:00</LastActive> <LastActivity>2025-06-03T04:41:26.4907723+00:00</LastActivity> <LastName>sample string 5</LastName> <PhoneNumber>sample string 8</PhoneNumber> <Role>Revoked</Role> <VillageId>56abb24b-1ff4-47d7-bcad-d8bb6fa25c3b</VillageId> <VillagerId>d87d221a-8873-4c92-af1d-eb273645f7bd</VillagerId> </VillagerModel> <VillagerModel> <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> <AvatarUrl>sample string 7</AvatarUrl> <Email>sample string 6</Email> <FirstName>sample string 4</FirstName> <Id>36f450f4-f80a-429c-8fbf-a4693a91b13b</Id> <Joined>2025-06-03T04:41:26.4907723+00:00</Joined> <LastActive>2025-06-03T04:41:26.4907723+00:00</LastActive> <LastActivity>2025-06-03T04:41:26.4907723+00:00</LastActivity> <LastName>sample string 5</LastName> <PhoneNumber>sample string 8</PhoneNumber> <Role>Revoked</Role> <VillageId>56abb24b-1ff4-47d7-bcad-d8bb6fa25c3b</VillageId> <VillagerId>d87d221a-8873-4c92-af1d-eb273645f7bd</VillagerId> </VillagerModel> </ArrayOfVillagerModel>