POST api/ProviderService/SendMessage?providerID={providerID}
Send Message
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| providerID | globally unique identifier |
Required |
Body Parameters
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. |
Request Formats
application/json, text/json
Sample:
{
"MessageId": "c7e339e7-bf28-4ffb-b9a0-f842a2505706",
"FromUser": {
"UserId": "231f3176-fba9-4cd2-862c-60377ae9806c",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
},
"ToUsers": [
{
"UserId": "231f3176-fba9-4cd2-862c-60377ae9806c",
"UserName": "sample string 2",
"UserType": "sample string 3",
"ImageName": "sample string 4"
},
{
"UserId": "231f3176-fba9-4cd2-862c-60377ae9806c",
"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": "2026-02-04T02:09:11.9082326+00:00",
"IsDeleted": true,
"IsRead": true,
"Folder": "sample string 4",
"SendOption": 0
}
application/xml, text/xml
Sample:
<MessageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
<Body>sample string 3</Body>
<Folder>sample string 4</Folder>
<FromUser>
<ImageName>sample string 4</ImageName>
<UserId>231f3176-fba9-4cd2-862c-60377ae9806c</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</FromUser>
<IsDeleted>true</IsDeleted>
<IsRead>true</IsRead>
<MessageId>c7e339e7-bf28-4ffb-b9a0-f842a2505706</MessageId>
<SelectedUserIDs>sample string 1</SelectedUserIDs>
<SendOption>To</SendOption>
<SentDate>2026-02-04T02:09:11.9082326+00:00</SentDate>
<Subject>sample string 2</Subject>
<ToUsers>
<MessageUser>
<ImageName>sample string 4</ImageName>
<UserId>231f3176-fba9-4cd2-862c-60377ae9806c</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</MessageUser>
<MessageUser>
<ImageName>sample string 4</ImageName>
<UserId>231f3176-fba9-4cd2-862c-60377ae9806c</UserId>
<UserName>sample string 2</UserName>
<UserType>sample string 3</UserType>
</MessageUser>
</ToUsers>
</MessageViewModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>