GET PlanCare2Api/ClientplansV2/{clientplanId}/PrimaryCare

Retrieve the selected acts 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 primarycare acts.

Collection of ClientplanArrangementProductAct

Name	Description	Type	Additional information
Id	The id of this act	integer	None
ActId	The id of the act	integer	None
ActName	The name of the act	string	None
ArrangementId	The id of the arrangement of this act	integer	None
ArrangementName	The name of the arrangement of this act	string	None
Status	The status of the act (0=Concept,1=Approved,2=InProgress,3=Historical)	ClientplanArrangementProductActStatus	None
StartDate	The date on which the act takes effect.	date	None
EndDate	The date on which the act will end or was ended.	date	None
TargetTime	The estimated time in minutes it takes to perform te act once.	integer	None
TargetCountPerWeek	Estimated times per week the act should be performed.	integer	None
AgreedTargetTime	The agreed time in minutes for the act.	integer	None
AgreedCountPerWeek	Times per week the act is performed.	integer	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "ActId": 2,
    "ActName": "sample string 3",
    "ArrangementId": 4,
    "ArrangementName": "sample string 5",
    "Status": 0,
    "StartDate": "2026-05-26T22:07:41.1026225+02:00",
    "EndDate": "2026-05-26T22:07:41.1026225+02:00",
    "TargetTime": 1,
    "TargetCountPerWeek": 1,
    "AgreedTargetTime": 1,
    "AgreedCountPerWeek": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientplanArrangementProductAct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanArrangementProductAct>
    <ActId>2</ActId>
    <ActName>sample string 3</ActName>
    <AgreedCountPerWeek>1</AgreedCountPerWeek>
    <AgreedTargetTime>1</AgreedTargetTime>
    <ArrangementId>4</ArrangementId>
    <ArrangementName>sample string 5</ArrangementName>
    <EndDate>2026-05-26T22:07:41.1026225+02:00</EndDate>
    <Id>1</Id>
    <StartDate>2026-05-26T22:07:41.1026225+02:00</StartDate>
    <Status>Concept</Status>
    <TargetCountPerWeek>1</TargetCountPerWeek>
    <TargetTime>1</TargetTime>
  </ClientplanArrangementProductAct>
  <ClientplanArrangementProductAct>
    <ActId>2</ActId>
    <ActName>sample string 3</ActName>
    <AgreedCountPerWeek>1</AgreedCountPerWeek>
    <AgreedTargetTime>1</AgreedTargetTime>
    <ArrangementId>4</ArrangementId>
    <ArrangementName>sample string 5</ArrangementName>
    <EndDate>2026-05-26T22:07:41.1026225+02:00</EndDate>
    <Id>1</Id>
    <StartDate>2026-05-26T22:07:41.1026225+02:00</StartDate>
    <Status>Concept</Status>
    <TargetCountPerWeek>1</TargetCountPerWeek>
    <TargetTime>1</TargetTime>
  </ClientplanArrangementProductAct>
</ArrayOfClientplanArrangementProductAct>