POST PlanCare2Api/ClientplansV2/{clientplanId}/ClientplanAgreements

Adds an Agreement to a Clientplan V2.

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

Request Information

URI Parameters

Name	Description	Type	Additional information
clientplanId	The clientplan Id.	integer	Required

Body Parameters

The agreement to add

ClientplanAgreement

Name	Description	Type	Additional information
Id	The internal id of the agreement	integer	Required
Name	The name of the agreement	string	Required
Description	The description of the agreement	string	None
ClientId	The internal id of the client	integer	None
ClientName	The name of the client	string	None
DomainId	The domain id related to the agreement	integer	None
DomainName	The domainname related to the agreement. For readonly purposes.	string	None
IsVisibleToAllDisciplines	Defines to whom the agreement is available True: The agreement is available for all disciplines False: The agreement is only available for defined disciplines	boolean	Required
AvailableForDisciplines	The Disciplines for whom the agreement is available	Collection of Discipline	None
StartDate	Startdate of the agreement	date	None
EndDate	Enddate of the agreement	date	None
StatusDate	The Statusdate when the state was set of the agreement	date	None
StatusDescription	The state of the agreement. For readonly purposes.	string	None

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ClientId": 4,
  "ClientName": "sample string 5",
  "DomainId": 1,
  "DomainName": "sample string 6",
  "IsVisibleToAllDisciplines": true,
  "AvailableForDisciplines": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "SpecialismCode": "sample string 4",
      "IsActual": true,
      "DisciplineGroupId": 6,
      "EvsFunction": "sample string 7",
      "EvsSpecialism": "sample string 8"
    },
    {
      "$ref": "2"
    }
  ],
  "StartDate": "2026-05-26T23:13:58.7130125+02:00",
  "EndDate": "2026-05-26T23:13:58.7130125+02:00",
  "StatusDate": "2026-05-26T23:13:58.7130125+02:00",
  "StatusDescription": "sample string 8"
}

application/xml, text/xml

Sample:

<ClientplanAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <AvailableForDisciplines xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
    <d2p1:Discipline>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DisciplineGroupId>6</d2p1:DisciplineGroupId>
      <d2p1:EvsFunction>sample string 7</d2p1:EvsFunction>
      <d2p1:EvsSpecialism>sample string 8</d2p1:EvsSpecialism>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsActual>true</d2p1:IsActual>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SpecialismCode>sample string 4</d2p1:SpecialismCode>
    </d2p1:Discipline>
    <d2p1:Discipline>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:DisciplineGroupId>6</d2p1:DisciplineGroupId>
      <d2p1:EvsFunction>sample string 7</d2p1:EvsFunction>
      <d2p1:EvsSpecialism>sample string 8</d2p1:EvsSpecialism>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsActual>true</d2p1:IsActual>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SpecialismCode>sample string 4</d2p1:SpecialismCode>
    </d2p1:Discipline>
  </AvailableForDisciplines>
  <ClientId>4</ClientId>
  <ClientName>sample string 5</ClientName>
  <Description>sample string 3</Description>
  <DomainId>1</DomainId>
  <DomainName>sample string 6</DomainName>
  <EndDate>2026-05-26T23:13:58.7130125+02:00</EndDate>
  <Id>1</Id>
  <IsVisibleToAllDisciplines>true</IsVisibleToAllDisciplines>
  <Name>sample string 2</Name>
  <StartDate>2026-05-26T23:13:58.7130125+02:00</StartDate>
  <StatusDate>2026-05-26T23:13:58.7130125+02:00</StatusDate>
  <StatusDescription>sample string 8</StatusDescription>
</ClientplanAgreement>

Response Information

Resource Description

The added Agreement

HttpResponseMessage

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