GET PlanCare2Api/Relations/{relationId}/Correlations/Treatment

Get treatment-correlations by relation.

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

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Treatment-correlations.

Collection of RelationCorrelationTreatmentSummary

Name	Description	Type	Additional information
CorrelationId	CorrelationId	integer	None
SourceRelationId	SourceRelationId	integer	None
SourceRelationLookUpName	SourceRelationLookUpName	string	None
TargetRelationId	TargetRelationId	integer	None
TargetRelationLookUpName	TargetRelationLookUpName	string	None
CorrelationRoleId	CorrelationRoleId	globally unique identifier	None
CorrelationRoleName	CorrelationRoleName	string	None
DisciplineId	DisciplineId	integer	None
DisciplineName	DisciplineName	string	None
ExcludeFromDossier	Exclude from dossier	boolean	None
Priority	Priority	integer	None
StartDate	Start date	date	None
EndDate	End date	date	None
Description	Description	string	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "CorrelationId": 1,
    "SourceRelationId": 2,
    "SourceRelationLookUpName": "sample string 3",
    "TargetRelationId": 4,
    "TargetRelationLookUpName": "sample string 5",
    "CorrelationRoleId": "233e4f7e-cac0-46d3-9d46-853092c350fa",
    "CorrelationRoleName": "sample string 6",
    "DisciplineId": 1,
    "DisciplineName": "sample string 7",
    "ExcludeFromDossier": true,
    "Priority": 9,
    "StartDate": "2026-05-26T23:13:03.4484116+02:00",
    "EndDate": "2026-05-26T23:13:03.4484116+02:00",
    "Description": "sample string 11"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfRelationCorrelationTreatmentSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
  <RelationCorrelationTreatmentSummary>
    <CorrelationId>1</CorrelationId>
    <CorrelationRoleId>233e4f7e-cac0-46d3-9d46-853092c350fa</CorrelationRoleId>
    <CorrelationRoleName>sample string 6</CorrelationRoleName>
    <Description>sample string 11</Description>
    <DisciplineId>1</DisciplineId>
    <DisciplineName>sample string 7</DisciplineName>
    <EndDate>2026-05-26T23:13:03.4484116+02:00</EndDate>
    <ExcludeFromDossier>true</ExcludeFromDossier>
    <Priority>9</Priority>
    <SourceRelationId>2</SourceRelationId>
    <SourceRelationLookUpName>sample string 3</SourceRelationLookUpName>
    <StartDate>2026-05-26T23:13:03.4484116+02:00</StartDate>
    <TargetRelationId>4</TargetRelationId>
    <TargetRelationLookUpName>sample string 5</TargetRelationLookUpName>
  </RelationCorrelationTreatmentSummary>
  <RelationCorrelationTreatmentSummary>
    <CorrelationId>1</CorrelationId>
    <CorrelationRoleId>233e4f7e-cac0-46d3-9d46-853092c350fa</CorrelationRoleId>
    <CorrelationRoleName>sample string 6</CorrelationRoleName>
    <Description>sample string 11</Description>
    <DisciplineId>1</DisciplineId>
    <DisciplineName>sample string 7</DisciplineName>
    <EndDate>2026-05-26T23:13:03.4484116+02:00</EndDate>
    <ExcludeFromDossier>true</ExcludeFromDossier>
    <Priority>9</Priority>
    <SourceRelationId>2</SourceRelationId>
    <SourceRelationLookUpName>sample string 3</SourceRelationLookUpName>
    <StartDate>2026-05-26T23:13:03.4484116+02:00</StartDate>
    <TargetRelationId>4</TargetRelationId>
    <TargetRelationLookUpName>sample string 5</TargetRelationLookUpName>
  </RelationCorrelationTreatmentSummary>
</ArrayOfRelationCorrelationTreatmentSummary>