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

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

At least one of these modules is required: Base

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

A list of legacy clientplanagreements a list of clientplanagreements and a list of clientagreements.

ClientReportAgreementCollection

Name	Description	Type	Additional information
LegacyClientplanAgreements	List of legacy clientplanagreements.	Collection of ClientReportLegacyClientplanAgreement	None.
ClientplanAgreements	List of clientplanagreements.	Collection of ClientReportClientplanAgreement	None.
Agreements	List of agreements.	Collection of ClientReportAgreement	None.

Response Formats

application/json, text/json

Sample:

{
  "LegacyClientplanAgreements": [
    {
      "$id": "2",
      "Id": 1,
      "Name": "sample string 2",
      "LegacyClientplanName": "sample string 3",
      "Description": "sample string 4"
    },
    {
      "$ref": "2"
    }
  ],
  "ClientplanAgreements": [
    {
      "$id": "3",
      "Id": 1,
      "Name": "sample string 1"
    },
    {
      "$ref": "3"
    }
  ],
  "Agreements": [
    {
      "$id": "4",
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "$ref": "4"
    }
  ]
}

application/xml, text/xml

Sample:

<ClientReportAgreementCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
  <Agreements>
    <ClientReportAgreement>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ClientReportAgreement>
    <ClientReportAgreement>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ClientReportAgreement>
  </Agreements>
  <ClientplanAgreements>
    <ClientReportClientplanAgreement>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </ClientReportClientplanAgreement>
    <ClientReportClientplanAgreement>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </ClientReportClientplanAgreement>
  </ClientplanAgreements>
  <LegacyClientplanAgreements>
    <ClientReportLegacyClientplanAgreement>
      <Description>sample string 4</Description>
      <Id>1</Id>
      <LegacyClientplanName>sample string 3</LegacyClientplanName>
      <Name>sample string 2</Name>
    </ClientReportLegacyClientplanAgreement>
    <ClientReportLegacyClientplanAgreement>
      <Description>sample string 4</Description>
      <Id>1</Id>
      <LegacyClientplanName>sample string 3</LegacyClientplanName>
      <Name>sample string 2</Name>
    </ClientReportLegacyClientplanAgreement>
  </LegacyClientplanAgreements>
</ClientReportAgreementCollection>