GET api/Village/{village}/TransferOwnership/GetOwnerCandidates?withRevoked={withRevoked}

Get list of users who can become the owner.

Request Information

URI Parameters

Name	Description	Type	Additional information
withRevoked	Include users whose access is currently revoked (defaults to false)	boolean	Default value is False
village		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of VillagerModel

Name	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.
Email	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": "ef212d93-41af-4602-a9c1-83c26bbf3e34",
    "VillageId": "19b48317-1f23-4abe-be0b-ac5c1e6c72ea",
    "VillagerId": "fa689167-5375-4b21-9be0-ea32e6582384",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "LastActivity": "2025-06-03T05:43:39.213+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-03T05:43:39.213+00:00",
    "LastActive": "2025-06-03T05:43:39.213+00:00"
  },
  {
    "Id": "ef212d93-41af-4602-a9c1-83c26bbf3e34",
    "VillageId": "19b48317-1f23-4abe-be0b-ac5c1e6c72ea",
    "VillagerId": "fa689167-5375-4b21-9be0-ea32e6582384",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "LastActivity": "2025-06-03T05:43:39.213+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-03T05:43:39.213+00:00",
    "LastActive": "2025-06-03T05:43:39.213+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>ef212d93-41af-4602-a9c1-83c26bbf3e34</Id>
    <Joined>2025-06-03T05:43:39.2132981+00:00</Joined>
    <LastActive>2025-06-03T05:43:39.2132981+00:00</LastActive>
    <LastActivity>2025-06-03T05:43:39.2132981+00:00</LastActivity>
    <LastName>sample string 5</LastName>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Role>Revoked</Role>
    <VillageId>19b48317-1f23-4abe-be0b-ac5c1e6c72ea</VillageId>
    <VillagerId>fa689167-5375-4b21-9be0-ea32e6582384</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>ef212d93-41af-4602-a9c1-83c26bbf3e34</Id>
    <Joined>2025-06-03T05:43:39.2132981+00:00</Joined>
    <LastActive>2025-06-03T05:43:39.2132981+00:00</LastActive>
    <LastActivity>2025-06-03T05:43:39.2132981+00:00</LastActivity>
    <LastName>sample string 5</LastName>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Role>Revoked</Role>
    <VillageId>19b48317-1f23-4abe-be0b-ac5c1e6c72ea</VillageId>
    <VillagerId>fa689167-5375-4b21-9be0-ea32e6582384</VillagerId>
  </VillagerModel>
</ArrayOfVillagerModel>