GET PlanCare2Api/WorkplansV2/{clientId}/Workplans

Retrieve all workplans V2 for client.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The client Id.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of workplans V2.

Collection of WorkplanV2Overview

Name	Description	Type	Additional information
Id	The internal id of the Workplan.	integer	-
Subject	The subject of the workplan.	string	-
TypeDescription	The type of the workplan.	string	-
Discipline	The discipline of the workplan.	string	-
DisciplineGroup	The discipline group of the workplan.	string	-
DomainName	The domain of the workplan.	string	-
Status	The status of the workplan.	WorkplanStatus	-
StatusDate	The statusdate of the workplan.	date	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Subject": "sample string 2",
    "TypeDescription": "sample string 3",
    "Discipline": "sample string 4",
    "DisciplineGroup": "sample string 5",
    "DomainName": "sample string 6",
    "Status": 0,
    "StatusDate": "2026-05-26T21:10:09.6987071+02:00"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfWorkplanV2Overview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <WorkplanV2Overview>
    <Discipline>sample string 4</Discipline>
    <DisciplineGroup>sample string 5</DisciplineGroup>
    <DomainName>sample string 6</DomainName>
    <Id>1</Id>
    <Status>Concept</Status>
    <StatusDate>2026-05-26T21:10:09.6987071+02:00</StatusDate>
    <Subject>sample string 2</Subject>
    <TypeDescription>sample string 3</TypeDescription>
  </WorkplanV2Overview>
  <WorkplanV2Overview>
    <Discipline>sample string 4</Discipline>
    <DisciplineGroup>sample string 5</DisciplineGroup>
    <DomainName>sample string 6</DomainName>
    <Id>1</Id>
    <Status>Concept</Status>
    <StatusDate>2026-05-26T21:10:09.6987071+02:00</StatusDate>
    <Subject>sample string 2</Subject>
    <TypeDescription>sample string 3</TypeDescription>
  </WorkplanV2Overview>
</ArrayOfWorkplanV2Overview>