GET api/Village/{village}/Invitations

Get a list of pending invitations for the specified village

Request Information

URI Parameters

Name	Description	Type	Additional information
village	Village ID	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of InviteeModel

Name	Description	Type	Additional information
Id	Unique ID of this invitation	globally unique identifier	None.
VillageId	Village's unique ID	globally unique identifier	None.
Name	Invitee's Name	string	None.
Invited	Date the invitation was last sent	date	None.
Role	Invitee's role in the village	UserVillageRole	None.
Email	Invitee's email address	string	None.
InvitedBy	Name of the user who invited this person	string	None.
InvitedById	ID of the user who invited this person	globally unique identifier	None.
LastSent	Date/Time the invitation was last sent (for invitations which have not been re-sent this will match the Invited field)	date	None.
LastSentBy	Name of the user who last sent the invitation (for invitations which have not been re-sent this will match the InvitedBy field)	string	None.
LastSentById	ID of the user who last sent the invitation (for invitations which have not been re-sent this will match the InvitedById field; for invitations which were re-sent automatically by the system this will be Guid.Empty (00000000-0000-0000-0000-000000000000)	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "d9062f56-a434-4d98-b569-b4d9eda0f238",
    "VillageId": "d9d097b4-6e9f-40e6-9115-0bdbd6776f33",
    "Name": "sample string 3",
    "Invited": "2025-06-03T04:39:46.473+00:00",
    "Role": 0,
    "Email": "sample string 5",
    "InvitedBy": "sample string 6",
    "InvitedById": "10d3490f-4d3b-43c1-a73f-8a4c30912eb4",
    "LastSent": "2025-06-03T04:39:46.473+00:00",
    "LastSentBy": "sample string 9",
    "LastSentById": "6bf06534-4bdf-46b2-a620-a8cc671054bb"
  },
  {
    "Id": "d9062f56-a434-4d98-b569-b4d9eda0f238",
    "VillageId": "d9d097b4-6e9f-40e6-9115-0bdbd6776f33",
    "Name": "sample string 3",
    "Invited": "2025-06-03T04:39:46.473+00:00",
    "Role": 0,
    "Email": "sample string 5",
    "InvitedBy": "sample string 6",
    "InvitedById": "10d3490f-4d3b-43c1-a73f-8a4c30912eb4",
    "LastSent": "2025-06-03T04:39:46.473+00:00",
    "LastSentBy": "sample string 9",
    "LastSentById": "6bf06534-4bdf-46b2-a620-a8cc671054bb"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInviteeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <InviteeModel>
    <Email>sample string 5</Email>
    <Id>d9062f56-a434-4d98-b569-b4d9eda0f238</Id>
    <Invited>2025-06-03T04:39:46.4735215+00:00</Invited>
    <InvitedBy>sample string 6</InvitedBy>
    <InvitedById>10d3490f-4d3b-43c1-a73f-8a4c30912eb4</InvitedById>
    <LastSent>2025-06-03T04:39:46.4735215+00:00</LastSent>
    <LastSentBy>sample string 9</LastSentBy>
    <LastSentById>6bf06534-4bdf-46b2-a620-a8cc671054bb</LastSentById>
    <Name>sample string 3</Name>
    <Role>Revoked</Role>
    <VillageId>d9d097b4-6e9f-40e6-9115-0bdbd6776f33</VillageId>
  </InviteeModel>
  <InviteeModel>
    <Email>sample string 5</Email>
    <Id>d9062f56-a434-4d98-b569-b4d9eda0f238</Id>
    <Invited>2025-06-03T04:39:46.4735215+00:00</Invited>
    <InvitedBy>sample string 6</InvitedBy>
    <InvitedById>10d3490f-4d3b-43c1-a73f-8a4c30912eb4</InvitedById>
    <LastSent>2025-06-03T04:39:46.4735215+00:00</LastSent>
    <LastSentBy>sample string 9</LastSentBy>
    <LastSentById>6bf06534-4bdf-46b2-a620-a8cc671054bb</LastSentById>
    <Name>sample string 3</Name>
    <Role>Revoked</Role>
    <VillageId>d9d097b4-6e9f-40e6-9115-0bdbd6776f33</VillageId>
  </InviteeModel>
</ArrayOfInviteeModel>