POST PlanCare2Api/PlanCareMessages/Forward

Post a forward message.

Request Information

URI Parameters

None.

Body Parameters

Forward to send.

Name	Description	Type	Additional information
RelatedMessageId	Internal id of the related message.	integer	Required
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	-
Client	Optional: The Identity of the Client involved	Identity	-

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<Forward xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <Body>sample string 3</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>
  <Client xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </Client>
  <RequestReadConfirmation>true</RequestReadConfirmation>
  <Subject>sample string 2</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>
  <RelatedMessageId>1</RelatedMessageId>
</Forward>

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	-
Content	HttpContent	-
StatusCode	HttpStatusCode	-
ReasonPhrase	string	-
Headers	Collection of Object	-
RequestMessage	HttpRequestMessage	-
IsSuccessStatusCode	boolean	-