GET PlanCare2Api/ClientReports/Goal?goalId={goalId}

Retrieve details for a single goal.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

Request Information

URI Parameters

Name	Description	Type	Additional information
goalId	The identifier of the goal or legacy goal to fetch.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Two collections are returned. The requested goal will be the single result in either the goals- or the legacy goals collection.

ClientReportGoalCollection

Name	Description	Type	Additional information
Goals	A list of clientplan-goals and subgoals and actions	Collection of ClientReportGoal	-
GoalsLegacy	A list of (legacy)clientplan-goals and workplans and actions	Collection of ClientReportGoal	-

Response Formats

application/json, text/json

Sample:

{
  "Goals": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2",
      "Actions": [
        {
          "$id": "3",
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "$ref": "3"
        }
      ],
      "SubGoals": [
        {
          "$id": "4",
          "Id": 1,
          "Name": "sample string 2",
          "Actions": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ],
          "WorkplanDisciplineId": 1,
          "WorkplanDisciplineName": "sample string 3",
          "WorkplanDisciplineGroupId": 1,
          "WorkplanDisciplineGroupName": "sample string 4"
        },
        {
          "$ref": "4"
        }
      ]
    },
    {
      "$ref": "2"
    }
  ],
  "GoalsLegacy": [
    {
      "$ref": "2"
    },
    {
      "$ref": "2"
    }
  ]
}

application/xml, text/xml

Sample:

<ClientReportGoalCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <Goals>
    <ClientReportGoal>
      <Actions>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
      </Actions>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <SubGoals>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
      </SubGoals>
    </ClientReportGoal>
    <ClientReportGoal>
      <Actions>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
      </Actions>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <SubGoals>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
      </SubGoals>
    </ClientReportGoal>
  </Goals>
  <GoalsLegacy>
    <ClientReportGoal>
      <Actions>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
      </Actions>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <SubGoals>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
      </SubGoals>
    </ClientReportGoal>
    <ClientReportGoal>
      <Actions>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
        <ClientReportAction>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </ClientReportAction>
      </Actions>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <SubGoals>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
        <ClientReportSubGoal>
          <Actions>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
            <ClientReportAction>
              <Id>1</Id>
              <Name>sample string 2</Name>
            </ClientReportAction>
          </Actions>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <WorkplanDisciplineGroupId>1</WorkplanDisciplineGroupId>
          <WorkplanDisciplineGroupName>sample string 4</WorkplanDisciplineGroupName>
          <WorkplanDisciplineId>1</WorkplanDisciplineId>
          <WorkplanDisciplineName>sample string 3</WorkplanDisciplineName>
        </ClientReportSubGoal>
      </SubGoals>
    </ClientReportGoal>
  </GoalsLegacy>
</ClientReportGoalCollection>