GET PlanCare2Api/ClientReports/Involuntarycares?clientId={clientId}&referenceDate={referenceDate}
Retrieve all involuntarycare measures for the selected client that overlap with the given date.
Requires 'Start' 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 involuntarycare measures. |
integer |
Required |
| referenceDate |
The date the involuntarycare measures should overlap with. |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of involuntarycare measures.
Collection of ClientReportInvoluntaryCareMeasure| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The id of the involuntarycare measure. |
globally unique identifier |
None |
| IsStructural |
Specifies whether the measure is structural |
boolean |
None |
| Name |
The name of the involuntarycare measure. |
string |
None |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": "5d00cfa5-e5bf-4660-9d1b-8b5eac801e67",
"IsStructural": true,
"Name": "sample string 3"
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfClientReportInvoluntaryCareMeasure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.ClientReport">
<ClientReportInvoluntaryCareMeasure>
<Id>5d00cfa5-e5bf-4660-9d1b-8b5eac801e67</Id>
<IsStructural>true</IsStructural>
<Name>sample string 3</Name>
</ClientReportInvoluntaryCareMeasure>
<ClientReportInvoluntaryCareMeasure>
<Id>5d00cfa5-e5bf-4660-9d1b-8b5eac801e67</Id>
<IsStructural>true</IsStructural>
<Name>sample string 3</Name>
</ClientReportInvoluntaryCareMeasure>
</ArrayOfClientReportInvoluntaryCareMeasure>