GET PlanCare2Api/Workplans?clientId={clientId}

Retrieve all legacy workplans for the selected client. The current version workplans are available using the route /Clientplans/{clientplanId}/Workplans Also the details of workplans are available using the route /WorkplansV2/{workplanId}, /WorkplansV2/{workplanId}/appointments and /WorkplansV2/{workplanId}/evaluations

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The client for whom to fetch the workplans.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of workplans that belong to clientplans that have status 'in progress'.

Collection of Workplan

Name	Description	Type	Additional information
Id	The internal id of the workplan.	integer	None
Name	The name of the workplan.	string	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfWorkplan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <Workplan>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Workplan>
  <Workplan>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Workplan>
</ArrayOfWorkplan>