POST PlanCare2Api/Relations/Correlations/Treatment/SetEndDate

Update end date of a treatment-correlation.

Request Information

URI Parameters

None.

Body Parameters

Object containing the correlation id and its new end date.

ChangeRelationCorrelationTreatmentEndDate
Name Description Type Additional information
CorrelationId

CorrelationId

integer

-

EndDate

End date

date

Nullable

Request Formats

application/json, text/json

Sample:
{
  "CorrelationId": 1,
  "EndDate": "2026-05-26T23:13:14.3688562+02:00"
}

application/xml, text/xml

Sample:
<ChangeRelationCorrelationTreatmentEndDate 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>
  <EndDate>2026-05-26T23:13:14.3688562+02:00</EndDate>
</ChangeRelationCorrelationTreatmentEndDate>

Response Information

Resource Description

The updated 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": "175e39d4-15d6-4e43-b4e5-cce242c7421f",
  "DisciplineId": 1,
  "ExcludeFromDossier": true,
  "Priority": 5,
  "StartDate": "2026-05-26T23:13:14.3688562+02:00",
  "EndDate": "2026-05-26T23:13:14.3688562+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>175e39d4-15d6-4e43-b4e5-cce242c7421f</CorrelationRoleId>
  <Description>sample string 6</Description>
  <DisciplineId>1</DisciplineId>
  <EndDate>2026-05-26T23:13:14.3688562+02:00</EndDate>
  <ExcludeFromDossier>true</ExcludeFromDossier>
  <Priority>5</Priority>
  <SourceRelationId>2</SourceRelationId>
  <StartDate>2026-05-26T23:13:14.3688562+02:00</StartDate>
  <TargetRelationId>3</TargetRelationId>
</RelationCorrelationTreatment>