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
NameDescriptionTypeAdditional information
CorrelationId

CorrelationId

integer

None

EndDate

End date

date

None

Request Formats

application/json, text/json

Sample:
{
  "CorrelationId": 1,
  "EndDate": "2026-05-26T21:11:01.7661927+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-26T21:11:01.7661927+02:00</EndDate>
</ChangeRelationCorrelationTreatmentEndDate>

Response Information

Resource Description

The updated 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": "9e328f84-f15b-4ce3-a2b6-f1482fdd9698",
  "DisciplineId": 1,
  "ExcludeFromDossier": true,
  "Priority": 5,
  "StartDate": "2026-05-26T21:11:01.7661927+02:00",
  "EndDate": "2026-05-26T21:11:01.7661927+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>9e328f84-f15b-4ce3-a2b6-f1482fdd9698</CorrelationRoleId>
  <Description>sample string 7</Description>
  <DisciplineId>1</DisciplineId>
  <EndDate>2026-05-26T21:11:01.7661927+02:00</EndDate>
  <ExcludeFromDossier>true</ExcludeFromDossier>
  <Priority>5</Priority>
  <SourceRelationId>2</SourceRelationId>
  <StartDate>2026-05-26T21:11:01.7661927+02:00</StartDate>
  <TargetRelationId>3</TargetRelationId>
</RelationCorrelationTreatment>