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

Retrieve all maingoals for the provided visionModelItem.

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 identifier of the visionmodelItem.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of maingoals.

Collection of MainGoal
Name Description Type Additional information
Id

The internal id of the MainGoal

globally unique identifier

-

Name

The name of the MainGoal

string

-

Code

The code of the MainGoal

string

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": "9712565b-594e-42f6-94a2-d57e0b464321",
    "Name": "sample string 2",
    "Code": "sample string 3"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMainGoal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <MainGoal>
    <Code>sample string 3</Code>
    <Id>9712565b-594e-42f6-94a2-d57e0b464321</Id>
    <Name>sample string 2</Name>
  </MainGoal>
  <MainGoal>
    <Code>sample string 3</Code>
    <Id>9712565b-594e-42f6-94a2-d57e0b464321</Id>
    <Name>sample string 2</Name>
  </MainGoal>
</ArrayOfMainGoal>