GET PlanCare2Api/ClientReports/Episodes?clientId={clientId}&referenceDate={referenceDate}

Retrieve all episodes for the selected client that overlap with the given date.

At least one of these modules is required: EBD

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

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The client for whom to fetch the episodes.	integer	Required
referenceDate	The date the episode should overlap with.	date	Required

Body Parameters

None.

Response Information

Resource Description

A list of episodes including actions and subgoals.

Collection of ClientReportEpisode

Name	Description	Type	Additional information
Id	The id of the episode.	integer	None
Name	The name of the episode.	string	None
Actions	List of actions associated with the episode.	Collection of ClientReportAction	None
SubGoals	List of subgoals associated with the episode. Includes a list of actions.	Collection of ClientReportSubGoal	None

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ArrayOfClientReportEpisode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <ClientReportEpisode>
    <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>
  </ClientReportEpisode>
  <ClientReportEpisode>
    <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>
  </ClientReportEpisode>
</ArrayOfClientReportEpisode>