GET PlanCare2Api/ClientplansV2/{clientplanId}/ClientplanAgreements

Retrieve the Agreements of a clientplan V2.

Requires 'Start' 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

None.

Response Information

Resource Description

A list of ClientplanAgreement

Collection of 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	-
ClientId	The internal id of the client	integer	-
ClientName	The name of the client	string	-
DomainId	The domain id related to the agreement	integer	Nullable
DomainName	The domainname related to the agreement. For readonly purposes.	string	-
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	-
StartDate	Startdate of the agreement	date	Nullable
EndDate	Enddate of the agreement	date	Nullable
StatusDate	The Statusdate when the state was set of the agreement	date	Nullable
StatusDescription	The state of the agreement. For readonly purposes.	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "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",
        "ReferralAllowed": true
      },
      {
        "$ref": "2"
      }
    ],
    "StartDate": "2026-05-26T21:08:51.9606853+02:00",
    "EndDate": "2026-05-26T21:08:51.9606853+02:00",
    "StatusDate": "2026-05-26T21:08:51.9606853+02:00",
    "StatusDescription": "sample string 8"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientplanAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanAgreement>
    <AvailableForDisciplines xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Discipline>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:DisciplineGroupId>6</d3p1:DisciplineGroupId>
        <d3p1:EvsFunction>sample string 7</d3p1:EvsFunction>
        <d3p1:EvsSpecialism>sample string 8</d3p1:EvsSpecialism>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsActual>true</d3p1:IsActual>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ReferralAllowed>true</d3p1:ReferralAllowed>
        <d3p1:SpecialismCode>sample string 4</d3p1:SpecialismCode>
      </d3p1:Discipline>
      <d3p1:Discipline>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:DisciplineGroupId>6</d3p1:DisciplineGroupId>
        <d3p1:EvsFunction>sample string 7</d3p1:EvsFunction>
        <d3p1:EvsSpecialism>sample string 8</d3p1:EvsSpecialism>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsActual>true</d3p1:IsActual>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ReferralAllowed>true</d3p1:ReferralAllowed>
        <d3p1:SpecialismCode>sample string 4</d3p1:SpecialismCode>
      </d3p1: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-26T21:08:51.9606853+02:00</EndDate>
    <Id>1</Id>
    <IsVisibleToAllDisciplines>true</IsVisibleToAllDisciplines>
    <Name>sample string 2</Name>
    <StartDate>2026-05-26T21:08:51.9606853+02:00</StartDate>
    <StatusDate>2026-05-26T21:08:51.9606853+02:00</StatusDate>
    <StatusDescription>sample string 8</StatusDescription>
  </ClientplanAgreement>
  <ClientplanAgreement>
    <AvailableForDisciplines xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
      <d3p1:Discipline>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:DisciplineGroupId>6</d3p1:DisciplineGroupId>
        <d3p1:EvsFunction>sample string 7</d3p1:EvsFunction>
        <d3p1:EvsSpecialism>sample string 8</d3p1:EvsSpecialism>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsActual>true</d3p1:IsActual>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ReferralAllowed>true</d3p1:ReferralAllowed>
        <d3p1:SpecialismCode>sample string 4</d3p1:SpecialismCode>
      </d3p1:Discipline>
      <d3p1:Discipline>
        <d3p1:Description>sample string 3</d3p1:Description>
        <d3p1:DisciplineGroupId>6</d3p1:DisciplineGroupId>
        <d3p1:EvsFunction>sample string 7</d3p1:EvsFunction>
        <d3p1:EvsSpecialism>sample string 8</d3p1:EvsSpecialism>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsActual>true</d3p1:IsActual>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:ReferralAllowed>true</d3p1:ReferralAllowed>
        <d3p1:SpecialismCode>sample string 4</d3p1:SpecialismCode>
      </d3p1: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-26T21:08:51.9606853+02:00</EndDate>
    <Id>1</Id>
    <IsVisibleToAllDisciplines>true</IsVisibleToAllDisciplines>
    <Name>sample string 2</Name>
    <StartDate>2026-05-26T21:08:51.9606853+02:00</StartDate>
    <StatusDate>2026-05-26T21:08:51.9606853+02:00</StatusDate>
    <StatusDescription>sample string 8</StatusDescription>
  </ClientplanAgreement>
</ArrayOfClientplanAgreement>