GET PlanCare2Api/Relations/{relationId}/Correlations

Get the correlations of correlationTypes where user has read permission for, for a client by relation Id

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

Request Information

URI Parameters

Name	Description	Type	Additional information
relationId	relation identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

The Correlations of correlationTypes where user has read permission for

Collection of Correlation

Name	Description	Type	Additional information
CorrelationId	Correlation id	integer	None.
SourceId	Source id	integer	None.
SourceName	Source name	string	None.
SourceRelationName	Relation description of the source	string	None.
ConnectionName	Name of the correlation type	string	Deprecated: Please use 'CorrelationType.Name' instead.
CorrelationType	Correlation type	CorrelationType	None.
TargetId	Target id	integer	None.
TargetName	Target Name	string	None.
TargetRelationName	Relation description of the target	string	None.
StartDate	Start date	date	None.
EndDate	End date	date	None.
CorrelationRoleId	Correlation Role id	globally unique identifier	None.
Description	Description	string	None.
DisciplineOrRoleName	Description or role name	string	None.
ExcludeFromDossier	Exclude from Dossier	boolean	None.
Priority	Priority	integer	None.
AllowAccessClientPortal	AllowAccessClientPortal	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "CorrelationId": 1,
    "SourceId": 2,
    "SourceName": "sample string 3",
    "SourceRelationName": "sample string 4",
    "ConnectionName": "sample string 2",
    "CorrelationType": {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2"
    },
    "TargetId": 1,
    "TargetName": "sample string 6",
    "TargetRelationName": "sample string 7",
    "StartDate": "2026-05-26T22:08:58.7477808+02:00",
    "EndDate": "2026-05-26T22:08:58.7477808+02:00",
    "CorrelationRoleId": "d483b875-f22f-463b-8180-807ed7a417de",
    "Description": "sample string 9",
    "DisciplineOrRoleName": "sample string 10",
    "ExcludeFromDossier": true,
    "Priority": 12,
    "AllowAccessClientPortal": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCorrelation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <Correlation>
    <AllowAccessClientPortal>true</AllowAccessClientPortal>
    <ConnectionName>sample string 2</ConnectionName>
    <CorrelationId>1</CorrelationId>
    <CorrelationRoleId>d483b875-f22f-463b-8180-807ed7a417de</CorrelationRoleId>
    <CorrelationType>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </CorrelationType>
    <Description>sample string 9</Description>
    <DisciplineOrRoleName>sample string 10</DisciplineOrRoleName>
    <EndDate>2026-05-26T22:08:58.7477808+02:00</EndDate>
    <ExcludeFromDossier>true</ExcludeFromDossier>
    <Priority>12</Priority>
    <SourceId>2</SourceId>
    <SourceName>sample string 3</SourceName>
    <SourceRelationName>sample string 4</SourceRelationName>
    <StartDate>2026-05-26T22:08:58.7477808+02:00</StartDate>
    <TargetId>1</TargetId>
    <TargetName>sample string 6</TargetName>
    <TargetRelationName>sample string 7</TargetRelationName>
  </Correlation>
  <Correlation>
    <AllowAccessClientPortal>true</AllowAccessClientPortal>
    <ConnectionName>sample string 2</ConnectionName>
    <CorrelationId>1</CorrelationId>
    <CorrelationRoleId>d483b875-f22f-463b-8180-807ed7a417de</CorrelationRoleId>
    <CorrelationType>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </CorrelationType>
    <Description>sample string 9</Description>
    <DisciplineOrRoleName>sample string 10</DisciplineOrRoleName>
    <EndDate>2026-05-26T22:08:58.7477808+02:00</EndDate>
    <ExcludeFromDossier>true</ExcludeFromDossier>
    <Priority>12</Priority>
    <SourceId>2</SourceId>
    <SourceName>sample string 3</SourceName>
    <SourceRelationName>sample string 4</SourceRelationName>
    <StartDate>2026-05-26T22:08:58.7477808+02:00</StartDate>
    <TargetId>1</TargetId>
    <TargetName>sample string 6</TargetName>
    <TargetRelationName>sample string 7</TargetRelationName>
  </Correlation>
</ArrayOfCorrelation>