GET PlanCare2Api/VisionModels/{visionModelId}/VisionModelItems/{visionModelItemId}/MainGoals/{mainGoalId}/GoalLibrary

Retrieve the goal library for the the provided mainGoal.

At least one of these modules is required: ICP

Request Information

URI Parameters

Name	Description	Type	Additional information
visionModelId	The identifier of the visionmodel.	integer	Required
visionModelItemId	The internal id of the visionModelItem.	integer	Required
mainGoalId	The mainGoal that is used to fetch the maingoals.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

The goal library.

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>