POST api/ProviderService/SendMessage?providerID={providerID}

Send Message

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerID

globally unique identifier

Required

Body Parameters

MessageViewModel
NameDescriptionTypeAdditional 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": "e6e2d792-90d2-43a2-bdfb-1973395c06b0",
  "FromUser": {
    "UserId": "d78f93ac-42d5-480d-a5be-59e34d3051b2",
    "UserName": "sample string 2",
    "UserType": "sample string 3",
    "ImageName": "sample string 4"
  },
  "ToUsers": [
    {
      "UserId": "d78f93ac-42d5-480d-a5be-59e34d3051b2",
      "UserName": "sample string 2",
      "UserType": "sample string 3",
      "ImageName": "sample string 4"
    },
    {
      "UserId": "d78f93ac-42d5-480d-a5be-59e34d3051b2",
      "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:58:22.8633678+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>d78f93ac-42d5-480d-a5be-59e34d3051b2</UserId>
    <UserName>sample string 2</UserName>
    <UserType>sample string 3</UserType>
  </FromUser>
  <IsDeleted>true</IsDeleted>
  <IsRead>true</IsRead>
  <MessageId>e6e2d792-90d2-43a2-bdfb-1973395c06b0</MessageId>
  <SelectedUserIDs>sample string 1</SelectedUserIDs>
  <SendOption>To</SendOption>
  <SentDate>2025-06-08T01:58:22.8633678+00:00</SentDate>
  <Subject>sample string 2</Subject>
  <ToUsers>
    <MessageUser>
      <ImageName>sample string 4</ImageName>
      <UserId>d78f93ac-42d5-480d-a5be-59e34d3051b2</UserId>
      <UserName>sample string 2</UserName>
      <UserType>sample string 3</UserType>
    </MessageUser>
    <MessageUser>
      <ImageName>sample string 4</ImageName>
      <UserId>d78f93ac-42d5-480d-a5be-59e34d3051b2</UserId>
      <UserName>sample string 2</UserName>
      <UserType>sample string 3</UserType>
    </MessageUser>
  </ToUsers>
</MessageViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MessageViewModel'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>