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

Get treatment-correlation by id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
correlationId

Id of correlation.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Treatment-correlation.

RelationCorrelationTreatment
NameDescriptionTypeAdditional information
CorrelationId

CorrelationId

integer

None

SourceRelationId

SourceRelationId

integer

None

TargetRelationId

TargetRelationId

integer

None

CorrelationRoleId

CorrelationRoleId

globally unique identifier

None

DisciplineId

DisciplineId

integer

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:
{
  "CorrelationId": 1,
  "SourceRelationId": 2,
  "TargetRelationId": 3,
  "CorrelationRoleId": "7346a126-8cba-4691-947d-7e2a840b3ca1",
  "DisciplineId": 1,
  "ExcludeFromDossier": true,
  "Priority": 5,
  "StartDate": "2026-05-26T23:13:54.2910557+02:00",
  "EndDate": "2026-05-26T23:13:54.2910557+02:00",
  "Description": "sample string 7"
}

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>7346a126-8cba-4691-947d-7e2a840b3ca1</CorrelationRoleId>
  <Description>sample string 7</Description>
  <DisciplineId>1</DisciplineId>
  <EndDate>2026-05-26T23:13:54.2910557+02:00</EndDate>
  <ExcludeFromDossier>true</ExcludeFromDossier>
  <Priority>5</Priority>
  <SourceRelationId>2</SourceRelationId>
  <StartDate>2026-05-26T23:13:54.2910557+02:00</StartDate>
  <TargetRelationId>3</TargetRelationId>
</RelationCorrelationTreatment>