GET PlanCare2Api/Goals?clientId={clientId}

Retrieve all goals for the selected client.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

A list of goals from all questions that belong to clientplans. Goals of both the legacy and current clientplan version are returned.

Collection of Goal

Name	Description	Type	Additional information
Id	The internal id of the goal.	integer	None.
Description	The description of the goal.	string	None.
InitialSituation	The description of the initial situation.	string	None.
TargetSituation	The description of the desired situation.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Description": "sample string 2",
    "InitialSituation": "sample string 3",
    "TargetSituation": "sample string 4"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGoal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <Goal>
    <Description>sample string 2</Description>
    <Id>1</Id>
    <InitialSituation>sample string 3</InitialSituation>
    <TargetSituation>sample string 4</TargetSituation>
  </Goal>
  <Goal>
    <Description>sample string 2</Description>
    <Id>1</Id>
    <InitialSituation>sample string 3</InitialSituation>
    <TargetSituation>sample string 4</TargetSituation>
  </Goal>
</ArrayOfGoal>