GET PlanCare2Api/Relations/{relationId}/Notes

Get notes by relation.

Relation(s) can be of the following types: Client, Prospect, Family, ContactPerson

Requires 'Start' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	Id of relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Notes.

Collection of RelationNoteSummary

Name	Description	Type	Additional information
Id	The internal id of the note	integer	None
Type	Type of the note	RelationNoteType	None
RelationId	The internal id of the relation	integer	None
RelationById	The internal id of the relation whom added/mutated the note	integer	None
Date	The date of the note	date	None
Text	The text of the note	string	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Type": {
      "$id": "2",
      "Guid": "b513ebed-3d75-4486-9d1f-8968852d27a3",
      "Text": "sample string 2"
    },
    "RelationId": 2,
    "RelationById": 3,
    "Date": "2026-05-26T23:13:03.5421635+02:00",
    "Text": "sample string 5"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfRelationNoteSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <RelationNoteSummary>
    <Date>2026-05-26T23:13:03.5421635+02:00</Date>
    <Id>1</Id>
    <RelationById>3</RelationById>
    <RelationId>2</RelationId>
    <Text>sample string 5</Text>
    <Type>
      <Guid>b513ebed-3d75-4486-9d1f-8968852d27a3</Guid>
      <Text>sample string 2</Text>
    </Type>
  </RelationNoteSummary>
  <RelationNoteSummary>
    <Date>2026-05-26T23:13:03.5421635+02:00</Date>
    <Id>1</Id>
    <RelationById>3</RelationById>
    <RelationId>2</RelationId>
    <Text>sample string 5</Text>
    <Type>
      <Guid>b513ebed-3d75-4486-9d1f-8968852d27a3</Guid>
      <Text>sample string 2</Text>
    </Type>
  </RelationNoteSummary>
</ArrayOfRelationNoteSummary>