GET PlanCare2Api/Relations/Correlations/Treatment/{correlationId}
Get treatment-correlation by id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| correlationId |
Id of correlation. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Treatment-correlation.
RelationCorrelationTreatment| Name | Description | Type | Additional information |
|---|---|---|---|
| CorrelationId |
CorrelationId |
integer |
- |
| SourceRelationId |
SourceRelationId |
integer |
- |
| TargetRelationId |
TargetRelationId |
integer |
- |
| CorrelationRoleId |
CorrelationRoleId |
globally unique identifier |
Nullable |
| DisciplineId |
DisciplineId |
integer |
Nullable |
| ExcludeFromDossier |
Exclude from dossier |
boolean |
- |
| Priority |
Priority |
integer |
- |
| StartDate |
Start date |
date |
Nullable |
| EndDate |
End date |
date |
Nullable |
| Description |
Description |
string |
- |
Response Formats
application/json, text/json
Sample:
{
"CorrelationId": 1,
"SourceRelationId": 2,
"TargetRelationId": 3,
"CorrelationRoleId": "6e01e954-685d-45fa-b37a-d381c3c56d37",
"DisciplineId": 1,
"ExcludeFromDossier": true,
"Priority": 5,
"StartDate": "2026-05-26T21:11:44.381+02:00",
"EndDate": "2026-05-26T21:11:44.381+02:00",
"Description": "sample string 6"
}
application/xml, text/xml
Sample:
<RelationCorrelationTreatment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation"> <CorrelationId>1</CorrelationId> <CorrelationRoleId>6e01e954-685d-45fa-b37a-d381c3c56d37</CorrelationRoleId> <Description>sample string 6</Description> <DisciplineId>1</DisciplineId> <EndDate>2026-05-26T21:11:44.381+02:00</EndDate> <ExcludeFromDossier>true</ExcludeFromDossier> <Priority>5</Priority> <SourceRelationId>2</SourceRelationId> <StartDate>2026-05-26T21:11:44.381+02:00</StartDate> <TargetRelationId>3</TargetRelationId> </RelationCorrelationTreatment>