POST PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{careplanId}/Domains/{domainId}/CareDemands/{careDemandId}/Goals/ChangeOfGoalV2

Updates an existing goal.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientplanId	The client plan V2 ID.	integer	Required
careplanId	The careplan ID.	integer	Required
domainId	The vision model domain ID.	integer	Required
careDemandId	The care demand ID.	integer	Required

Body Parameters

The goal to save

ChangeOfGoalV2

Name	Description	Type	Additional information
AggregateId	The aggregateId of the goal.	globally unique identifier	Required
Id	The id of the goal.	integer	Deprecated (unavailable from 21.01.1P): Please use 'AggregateId' instead.
CareDemandName	The name of the CareDemand.	string	Required
CareDemandId	The id of the CareDemand.	integer	Required
CareDemandExplanation	The remarks of the CareDemand	string	-
TemplateGoalId	The id of the TemplateGoal.	integer	Nullable
PreviousGoalId	The id of the previous Goal.	integer	Nullable
QuestionnaireGoalId	The id of the QuestionnaireGoal.	integer	Nullable
StartDate	The start date of the Goal.	date	Nullable
EndDate	The end date of the Goal.	date	Nullable
Name	The name of the Goal.	string	Required
Status	The state of the Goal.	ClientplanPartGoalStatus	-
StatusDescription	The description of the state of the Goal.	string	-
StatusDate	The status date of the Goal.	date	-
InitialSituation	The initial situation.	string	-
TargetSituation	The target situation.	string	-
DisciplineIds	The ids of the disciplines.	Collection of integer	-
DisciplineGroupIds	The ids of the discipline groups.	Collection of integer	-
LatestScore	The latest score of the Goal.	Score	-
MainGoalId	The id of the MainGoal	globally unique identifier	Nullable
MainGoal	The name of the MainGoal	string	-

Request Formats

application/json, text/json

Sample:

{
  "AggregateId": "0398fbd1-b065-44e2-89fa-aa76a1e8ebc6",
  "Id": 2,
  "CareDemandName": "sample string 3",
  "CareDemandId": 4,
  "CareDemandExplanation": "sample string 5",
  "TemplateGoalId": 1,
  "PreviousGoalId": 1,
  "QuestionnaireGoalId": 1,
  "StartDate": "2026-05-26T22:09:52.8908354+02:00",
  "EndDate": "2026-05-26T22:09:52.8908354+02:00",
  "Name": "sample string 6",
  "Status": 0,
  "StatusDescription": "sample string 7",
  "StatusDate": "2026-05-26T22:09:52.8908354+02:00",
  "InitialSituation": "sample string 9",
  "TargetSituation": "sample string 10",
  "DisciplineIds": [
    1,
    2
  ],
  "DisciplineGroupIds": [
    1,
    2
  ],
  "LatestScore": {
    "$id": "2",
    "Color": 1,
    "Description": "sample string 2",
    "Value": 3,
    "Rank": 4,
    "Name": "sample string 5"
  },
  "MainGoalId": "460f0953-24fb-49e6-876b-243c3c129fa0",
  "MainGoal": "sample string 11"
}

application/xml, text/xml

Sample:

<ChangeOfGoalV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <AggregateId>0398fbd1-b065-44e2-89fa-aa76a1e8ebc6</AggregateId>
  <CareDemandExplanation>sample string 5</CareDemandExplanation>
  <CareDemandId>4</CareDemandId>
  <CareDemandName>sample string 3</CareDemandName>
  <DisciplineGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </DisciplineGroupIds>
  <DisciplineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </DisciplineIds>
  <EndDate>2026-05-26T22:09:52.8908354+02:00</EndDate>
  <Id>2</Id>
  <InitialSituation>sample string 9</InitialSituation>
  <LatestScore>
    <Color>1</Color>
    <Description>sample string 2</Description>
    <Name>sample string 5</Name>
    <Rank>4</Rank>
    <Value>3</Value>
  </LatestScore>
  <MainGoal>sample string 11</MainGoal>
  <MainGoalId>460f0953-24fb-49e6-876b-243c3c129fa0</MainGoalId>
  <Name>sample string 6</Name>
  <PreviousGoalId>1</PreviousGoalId>
  <QuestionnaireGoalId>1</QuestionnaireGoalId>
  <StartDate>2026-05-26T22:09:52.8908354+02:00</StartDate>
  <Status>Concept</Status>
  <StatusDate>2026-05-26T22:09:52.8908354+02:00</StatusDate>
  <StatusDescription>sample string 7</StatusDescription>
  <TargetSituation>sample string 10</TargetSituation>
  <TemplateGoalId>1</TemplateGoalId>
</ChangeOfGoalV2>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved goal instance

HttpResponseMessage

Name	Type	Additional information
Version	Version	-
Content	HttpContent	-
StatusCode	HttpStatusCode	-
ReasonPhrase	string	-
Headers	Collection of Object	-
RequestMessage	HttpRequestMessage	-
IsSuccessStatusCode	boolean	-