GET api/ProviderService/GetMessages?folderName={folderName}&providerID={providerID}
Get Messages
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| folderName | string |
Required |
|
| providerID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of MessageViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageId | globally unique identifier |
None. |
|
| FromUser | MessageUser |
None. |
|
| ToUsers | Collection of MessageUser |
None. |
|
| SelectedUserIDs | string |
None. |
|
| Subject | string |
None. |
|
| Body | string |
None. |
|
| SentDate | date |
None. |
|
| IsDeleted | boolean |
None. |
|
| IsRead | boolean |
None. |
|
| Folder | string |
None. |
|
| SendOption | EnumMessageSendOptions |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"MessageId": "24f7d7c4-f279-464b-9513-6664ff25fff0",
"FromUser": {
"UserId": "511d0bc7-92ca-40d9-a8b2-641bbc0f3c43",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
},
"ToUsers": [
{
"UserId": "511d0bc7-92ca-40d9-a8b2-641bbc0f3c43",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
},
{
"UserId": "511d0bc7-92ca-40d9-a8b2-641bbc0f3c43",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
}
],
"SelectedUserIDs": "sample string 1",
"Subject": "sample string 2",
"Body": "sample string 3",
"SentDate": "2025-12-14T08:57:32.5315918+00:00",
"IsDeleted": true,
"IsRead": true,
"Folder": "sample string 4",
"SendOption": 0
},
{
"MessageId": "24f7d7c4-f279-464b-9513-6664ff25fff0",
"FromUser": {
"UserId": "511d0bc7-92ca-40d9-a8b2-641bbc0f3c43",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
},
"ToUsers": [
{
"UserId": "511d0bc7-92ca-40d9-a8b2-641bbc0f3c43",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
},
{
"UserId": "511d0bc7-92ca-40d9-a8b2-641bbc0f3c43",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
}
],
"SelectedUserIDs": "sample string 1",
"Subject": "sample string 2",
"Body": "sample string 3",
"SentDate": "2025-12-14T08:57:32.5315918+00:00",
"IsDeleted": true,
"IsRead": true,
"Folder": "sample string 4",
"SendOption": 0
}
]
application/xml, text/xml
Sample:
<ArrayOfMessageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
<MessageViewModel>
<Body>sample string 3</Body>
<Folder>sample string 4</Folder>
<FromUser>
<ImageName>sample string 4</ImageName>
<UserId>511d0bc7-92ca-40d9-a8b2-641bbc0f3c43</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</FromUser>
<IsDeleted>true</IsDeleted>
<IsRead>true</IsRead>
<MessageId>24f7d7c4-f279-464b-9513-6664ff25fff0</MessageId>
<SelectedUserIDs>sample string 1</SelectedUserIDs>
<SendOption>To</SendOption>
<SentDate>2025-12-14T08:57:32.5315918+00:00</SentDate>
<Subject>sample string 2</Subject>
<ToUsers>
<MessageUser>
<ImageName>sample string 4</ImageName>
<UserId>511d0bc7-92ca-40d9-a8b2-641bbc0f3c43</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</MessageUser>
<MessageUser>
<ImageName>sample string 4</ImageName>
<UserId>511d0bc7-92ca-40d9-a8b2-641bbc0f3c43</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</MessageUser>
</ToUsers>
</MessageViewModel>
<MessageViewModel>
<Body>sample string 3</Body>
<Folder>sample string 4</Folder>
<FromUser>
<ImageName>sample string 4</ImageName>
<UserId>511d0bc7-92ca-40d9-a8b2-641bbc0f3c43</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</FromUser>
<IsDeleted>true</IsDeleted>
<IsRead>true</IsRead>
<MessageId>24f7d7c4-f279-464b-9513-6664ff25fff0</MessageId>
<SelectedUserIDs>sample string 1</SelectedUserIDs>
<SendOption>To</SendOption>
<SentDate>2025-12-14T08:57:32.5315918+00:00</SentDate>
<Subject>sample string 2</Subject>
<ToUsers>
<MessageUser>
<ImageName>sample string 4</ImageName>
<UserId>511d0bc7-92ca-40d9-a8b2-641bbc0f3c43</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</MessageUser>
<MessageUser>
<ImageName>sample string 4</ImageName>
<UserId>511d0bc7-92ca-40d9-a8b2-641bbc0f3c43</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</MessageUser>
</ToUsers>
</MessageViewModel>
</ArrayOfMessageViewModel>