GET PlanCare2Api/PlanCareMessages?folder={folder}

Gets all messages.

Request Information

URI Parameters

Name	Description	Type	Additional information
folder	Folder messages to get from.	MessageFolder	Required

Body Parameters

None.

Response Information

Resource Description

The list of all messages.

Collection of PlanCareMessage

Name	Description	Type	Additional information
Id	The PlanCare2 id of the message.	integer	-
From	The sender of the message. Must correspond with the logged in user.	MessageAddress	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	-
SentDate	The time the message has been sent.	date	Nullable
RequestReadConformation	Set when the recipients should send a received conformation.	boolean	Required Deprecated (unavailable from 21.01.1P): Please use 'RequestReadConfirmation' instead.
RequestReadConfirmation	Set when the recipients should send a received confirmation.	boolean	Required
ClientId	Optional: The Identity of the Client involved	Identity	-
Type	The type of the message.	MessageType	-
RelatedMessageId	Internal id of the related message.	integer	Nullable
CalendarPlannedItemId	The PlanCare2 id of the appointment the message is related to.	integer	Nullable
RecurrenceText	Description of the recurrence of the appointment. Empty when the appointment is not recurring.	string	-
IsRead	Is the message marked as 'read' by the currently logged on user.	boolean	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "From": {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2",
      "Type": 1
    },
    "To": [
      {
        "$ref": "2"
      },
      {
        "$ref": "2"
      }
    ],
    "Cc": [
      {
        "$ref": "2"
      },
      {
        "$ref": "2"
      }
    ],
    "Subject": "sample string 2",
    "Body": "sample string 3",
    "SentDate": "2026-05-26T23:17:30.3552392+02:00",
    "RequestReadConformation": true,
    "RequestReadConfirmation": true,
    "ClientId": {
      "$id": "3",
      "Identifier": "sample string 1",
      "Type": 0
    },
    "Type": 0,
    "RelatedMessageId": 1,
    "CalendarPlannedItemId": 1,
    "RecurrenceText": "sample string 6",
    "IsRead": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPlanCareMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
  <PlanCareMessage>
    <Body>sample string 3</Body>
    <CalendarPlannedItemId>1</CalendarPlannedItemId>
    <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>
    <ClientId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </ClientId>
    <From>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Relation</Type>
    </From>
    <Id>1</Id>
    <IsRead>true</IsRead>
    <RecurrenceText>sample string 6</RecurrenceText>
    <RelatedMessageId>1</RelatedMessageId>
    <RequestReadConfirmation>true</RequestReadConfirmation>
    <RequestReadConformation>true</RequestReadConformation>
    <SentDate>2026-05-26T23:17:30.3552392+02:00</SentDate>
    <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>
    <Type>Message</Type>
  </PlanCareMessage>
  <PlanCareMessage>
    <Body>sample string 3</Body>
    <CalendarPlannedItemId>1</CalendarPlannedItemId>
    <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>
    <ClientId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </ClientId>
    <From>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>Relation</Type>
    </From>
    <Id>1</Id>
    <IsRead>true</IsRead>
    <RecurrenceText>sample string 6</RecurrenceText>
    <RelatedMessageId>1</RelatedMessageId>
    <RequestReadConfirmation>true</RequestReadConfirmation>
    <RequestReadConformation>true</RequestReadConformation>
    <SentDate>2026-05-26T23:17:30.3552392+02:00</SentDate>
    <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>
    <Type>Message</Type>
  </PlanCareMessage>
</ArrayOfPlanCareMessage>