POST PlanCare2Api/PlanCareMessages/Reply

Post a reply message.

Request Information

URI Parameters

None.

Body Parameters

Reply to send.

Reply
Name Description Type Additional information
To

The addresses the message is sent to.

Collection of MessageAddress

Required

Cc

Addresses that should receive a carbon copy of the message.

Collection of MessageAddress

-

Subject

The subject of the message.

string

Required

Body

The message body.

string

-

RequestReadConfirmation

Set when the recipients should send a read confirmation, false when empty.

boolean

-

RelatedMessageId

Internal id of the related message.

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "To": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2",
      "Type": 1
    },
    {
      "$ref": "2"
    }
  ],
  "Cc": [
    {
      "$ref": "2"
    },
    {
      "$ref": "2"
    }
  ],
  "Subject": "sample string 1",
  "Body": "sample string 2",
  "RequestReadConfirmation": true,
  "RelatedMessageId": 4
}

application/xml, text/xml

Sample:
<Reply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <Body>sample string 2</Body>
  <Cc>
    <MessageAddress>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Relation</Type>
    </MessageAddress>
    <MessageAddress>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Relation</Type>
    </MessageAddress>
  </Cc>
  <RelatedMessageId>4</RelatedMessageId>
  <RequestReadConfirmation>true</RequestReadConfirmation>
  <Subject>sample string 1</Subject>
  <To>
    <MessageAddress>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Relation</Type>
    </MessageAddress>
    <MessageAddress>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Relation</Type>
    </MessageAddress>
  </To>
</Reply>

Response Information

Resource Description

HttpResponseMessage
Name Description Type Additional information
Version

Version

-

Content

HttpContent

-

StatusCode

HttpStatusCode

-

ReasonPhrase

string

-

Headers

Collection of Object

-

RequestMessage

HttpRequestMessage

-

IsSuccessStatusCode

boolean

-