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 MessageViewModelName | 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": "600d91d5-79dc-4051-8070-88c05e598ffa", "FromUser": { "UserId": "9ab6868d-6a92-4946-a9d5-10ad91c89d0c", "UserName": "sample string 2", "UserType": "sample string 3", "ImageName": "sample string 4" }, "ToUsers": [ { "UserId": "9ab6868d-6a92-4946-a9d5-10ad91c89d0c", "UserName": "sample string 2", "UserType": "sample string 3", "ImageName": "sample string 4" }, { "UserId": "9ab6868d-6a92-4946-a9d5-10ad91c89d0c", "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-06-08T01:31:16.4884415+00:00", "IsDeleted": true, "IsRead": true, "Folder": "sample string 4", "SendOption": 0 }, { "MessageId": "600d91d5-79dc-4051-8070-88c05e598ffa", "FromUser": { "UserId": "9ab6868d-6a92-4946-a9d5-10ad91c89d0c", "UserName": "sample string 2", "UserType": "sample string 3", "ImageName": "sample string 4" }, "ToUsers": [ { "UserId": "9ab6868d-6a92-4946-a9d5-10ad91c89d0c", "UserName": "sample string 2", "UserType": "sample string 3", "ImageName": "sample string 4" }, { "UserId": "9ab6868d-6a92-4946-a9d5-10ad91c89d0c", "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-06-08T01:31:16.4884415+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>9ab6868d-6a92-4946-a9d5-10ad91c89d0c</UserId> <UserName>sample string 2</UserName> <UserType>sample string 3</UserType> </FromUser> <IsDeleted>true</IsDeleted> <IsRead>true</IsRead> <MessageId>600d91d5-79dc-4051-8070-88c05e598ffa</MessageId> <SelectedUserIDs>sample string 1</SelectedUserIDs> <SendOption>To</SendOption> <SentDate>2025-06-08T01:31:16.4884415+00:00</SentDate> <Subject>sample string 2</Subject> <ToUsers> <MessageUser> <ImageName>sample string 4</ImageName> <UserId>9ab6868d-6a92-4946-a9d5-10ad91c89d0c</UserId> <UserName>sample string 2</UserName> <UserType>sample string 3</UserType> </MessageUser> <MessageUser> <ImageName>sample string 4</ImageName> <UserId>9ab6868d-6a92-4946-a9d5-10ad91c89d0c</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>9ab6868d-6a92-4946-a9d5-10ad91c89d0c</UserId> <UserName>sample string 2</UserName> <UserType>sample string 3</UserType> </FromUser> <IsDeleted>true</IsDeleted> <IsRead>true</IsRead> <MessageId>600d91d5-79dc-4051-8070-88c05e598ffa</MessageId> <SelectedUserIDs>sample string 1</SelectedUserIDs> <SendOption>To</SendOption> <SentDate>2025-06-08T01:31:16.4884415+00:00</SentDate> <Subject>sample string 2</Subject> <ToUsers> <MessageUser> <ImageName>sample string 4</ImageName> <UserId>9ab6868d-6a92-4946-a9d5-10ad91c89d0c</UserId> <UserName>sample string 2</UserName> <UserType>sample string 3</UserType> </MessageUser> <MessageUser> <ImageName>sample string 4</ImageName> <UserId>9ab6868d-6a92-4946-a9d5-10ad91c89d0c</UserId> <UserName>sample string 2</UserName> <UserType>sample string 3</UserType> </MessageUser> </ToUsers> </MessageViewModel> </ArrayOfMessageViewModel>