GET PlanCare2Api/ClientplansV2/GoalLibrary?sectorId={sectorId}

Retrieve the library of clientplan goals.

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

Request Information

URI Parameters

Name	Description	Type	Additional information
sectorId	Sector identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of clientplan goals for the requested sector

Collection of GoalLibrary

Name	Description	Type	Additional information
Id	The internal id of the clientplan goal library.	integer	-
Name	The name of the clientplan goal library.	string	-
InitialSituation	The initial situation of the clientplan goal library.	string	-
TargetSituation	The target situation of the clientplan goal library.	string	-
SectorId	The sector id of the clientplan goal library.	integer	-

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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