GET api/Village/{village}/Conversation/{conversationId}/Metadata
Get the Conversation List entry for the specified conversation in the village
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
conversationId |
The ID of the conversation to retrieve |
globally unique identifier |
Required |
village | string |
None. |
Body Parameters
None.
Response Information
Resource Description
ConversationModelName | Description | Type | Additional information |
---|---|---|---|
ConversationId |
Conversation's Unique ID |
globally unique identifier |
None. |
VillageId |
Village's Unique ID |
globally unique identifier |
None. |
ConversationType |
Indicates the conversation type (0 = Group, 1 = Village, 2 = Private) |
ConversationType |
None. |
VillageConversation |
OBSOLETE, use ConversationType instead. If true, this is the default conversation for the Village |
boolean |
None. |
Archived |
If true, the user has archived this conversation |
boolean |
None. |
NewMessages |
The number of new messages since the last mesage the user read |
integer |
None. |
Title |
The title of the conversation (will be Village Name for the village conversation, or the name of the "other user" for a 1:1 conversation |
string |
None. |
Created |
Date/Time the conversation was created |
date |
None. |
OtherUserId |
Obsolete - ID of the other private conversation participant |
globally unique identifier |
None. |
MessageCount |
Number of messages in the conversation |
integer |
None. |
LastRead |
Sequence of the user's last-read message |
integer |
None. |
LastMessage |
The last message sent in the conversation |
string |
None. |
LastMessageIsAction |
If true, the last message is an "Action" message (something happened, vs. something was said) |
boolean |
None. |
LastMessageSent |
When the last message was sent |
date |
None. |
LastMessageSentById |
ID of the user who sent the last message |
globally unique identifier |
None. |
LastMessageSentBy |
Name (First L.) of the user who sent the last message |
string |
None. |
OtherUsers |
List of other conversation participants |
Collection of ConversationMemberModel |
None. |
Response Formats
application/json, text/json
{ "ConversationId": "69995cf2-416c-402e-acf0-1654a0aca403", "VillageId": "60c7144c-d420-443f-bc80-37cce8484ed0", "ConversationType": 0, "VillageConversation": false, "Archived": true, "NewMessages": 4, "Title": "sample string 5", "Created": "2025-06-03T05:50:14.424+00:00", "OtherUserId": null, "MessageCount": 7, "LastRead": 1, "LastMessage": "sample string 8", "LastMessageIsAction": true, "LastMessageSent": "2025-06-03T05:50:14.424+00:00", "LastMessageSentById": "96e16f36-f0e3-4fb5-86f7-0b82eb64391b", "LastMessageSentBy": "sample string 9", "OtherUsers": [ { "VillagerId": "5969f7c0-8974-419d-9b59-9f49ce32da4c", "Name": "sample string 2" }, { "VillagerId": "5969f7c0-8974-419d-9b59-9f49ce32da4c", "Name": "sample string 2" } ] }
application/xml, text/xml
<ConversationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models"> <Archived>true</Archived> <ConversationId>69995cf2-416c-402e-acf0-1654a0aca403</ConversationId> <ConversationType>Group</ConversationType> <Created>2025-06-03T05:50:14.4243196+00:00</Created> <LastMessage>sample string 8</LastMessage> <LastMessageIsAction>true</LastMessageIsAction> <LastMessageSent>2025-06-03T05:50:14.4243196+00:00</LastMessageSent> <LastMessageSentBy>sample string 9</LastMessageSentBy> <LastMessageSentById>96e16f36-f0e3-4fb5-86f7-0b82eb64391b</LastMessageSentById> <LastRead>1</LastRead> <MessageCount>7</MessageCount> <NewMessages>4</NewMessages> <OtherUsers> <ConversationMemberModel> <Name>sample string 2</Name> <VillagerId>5969f7c0-8974-419d-9b59-9f49ce32da4c</VillagerId> </ConversationMemberModel> <ConversationMemberModel> <Name>sample string 2</Name> <VillagerId>5969f7c0-8974-419d-9b59-9f49ce32da4c</VillagerId> </ConversationMemberModel> </OtherUsers> <Title>sample string 5</Title> <VillageId>60c7144c-d420-443f-bc80-37cce8484ed0</VillageId> </ConversationModel>