GET PlanCare2Api/ClientplansV2/{id}

Retrieve a clientplan V2.

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

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

A clientplan V2

ClientplanV2

Name	Description	Type	Additional information
Id	The internal id of the clientplan.	integer	None.
ClientId	The internal id of the client.	Identity	Required
StartDate	The date on which the clientplan takes effect.	date	Required
EndDate	The date on which the clientplan will end or was ended.	date	None.
SectorName	The name of the sector. For read-only purposes only.	string	None.
Name	The name of the clientplan.	string	Required
TypeId	The id of the type of the clientplan.	integer	Required
VisionModelName	The name of the vision model. For read-only purposes only.	string	None.
ResponsibleEmployeeName	The name of the responsible employee. For read-only purposes only.	string	None.
SectorId	The id of the sector of the clientplan.	integer	Required
VisionModelId	The id of the vision model of the clientplan.	integer	Required
ResponsibleEmployeeId	The responsible employee of the clientplan.	Identity	Required
BasicInformationInfo	The basic information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.
QuestionnaireInfo	The questionnaire information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.
CareplanInfo	The careplan information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.
OmahaSystemInfo	The Omaha System information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.
AgreementsInfo	The agreements information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.
PrimaryCareInfo	The primary care part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.
InvoluntaryCareInfo	The involuntary care part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.
WorkplanInfo	The workplan information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "ClientId": {
    "$id": "2",
    "Identifier": "sample string 1",
    "Type": 0
  },
  "StartDate": "2026-05-26T23:19:23.9305609+02:00",
  "EndDate": "2026-05-26T23:19:23.9305609+02:00",
  "SectorName": "sample string 3",
  "Name": "sample string 4",
  "TypeId": 5,
  "VisionModelName": "sample string 6",
  "ResponsibleEmployeeName": "sample string 7",
  "SectorId": 8,
  "VisionModelId": 9,
  "ResponsibleEmployeeId": {
    "$ref": "2"
  },
  "BasicInformationInfo": {
    "$id": "3",
    "TypeId": 1,
    "Name": "sample string 2",
    "IsVisible": true
  },
  "QuestionnaireInfo": {
    "$ref": "3"
  },
  "CareplanInfo": {
    "$ref": "3"
  },
  "OmahaSystemInfo": {
    "$ref": "3"
  },
  "AgreementsInfo": {
    "$ref": "3"
  },
  "PrimaryCareInfo": {
    "$ref": "3"
  },
  "InvoluntaryCareInfo": {
    "$ref": "3"
  },
  "WorkplanInfo": {
    "$ref": "3"
  }
}

application/xml, text/xml

Sample:

<ClientplanV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <AgreementsInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </AgreementsInfo>
  <BasicInformationInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </BasicInformationInfo>
  <CareplanInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </CareplanInfo>
  <ClientId xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </ClientId>
  <EndDate>2026-05-26T23:19:23.9305609+02:00</EndDate>
  <Id>1</Id>
  <InvoluntaryCareInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </InvoluntaryCareInfo>
  <Name>sample string 4</Name>
  <OmahaSystemInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </OmahaSystemInfo>
  <PrimaryCareInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </PrimaryCareInfo>
  <QuestionnaireInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </QuestionnaireInfo>
  <ResponsibleEmployeeId xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </ResponsibleEmployeeId>
  <ResponsibleEmployeeName>sample string 7</ResponsibleEmployeeName>
  <SectorId>8</SectorId>
  <SectorName>sample string 3</SectorName>
  <StartDate>2026-05-26T23:19:23.9305609+02:00</StartDate>
  <TypeId>5</TypeId>
  <VisionModelId>9</VisionModelId>
  <VisionModelName>sample string 6</VisionModelName>
  <WorkplanInfo>
    <IsVisible>true</IsVisible>
    <Name>sample string 2</Name>
    <TypeId>1</TypeId>
  </WorkplanInfo>
</ClientplanV2>