GET PlanCare2Api/ClientplansV2/Sectors?clientId={clientId}
Retrieve all clientplan Sectors by clientId.
Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
The id of the client. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of Sectors structures
Collection of ClientplanSector| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The internal id of the sector. |
integer |
None |
| Name |
The name of the sector. |
string |
None |
| StartDate |
The start date of the sector. |
date |
None |
| ActionVisible |
Whether or not the actions in the sector are visible for reporting. |
boolean |
None |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": 1,
"Name": "sample string 2",
"StartDate": "2026-05-26T23:13:06.0109582+02:00",
"ActionVisible": true
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfClientplanSector xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
<ClientplanSector>
<ActionVisible>true</ActionVisible>
<Id>1</Id>
<Name>sample string 2</Name>
<StartDate>2026-05-26T23:13:06.0109582+02:00</StartDate>
</ClientplanSector>
<ClientplanSector>
<ActionVisible>true</ActionVisible>
<Id>1</Id>
<Name>sample string 2</Name>
<StartDate>2026-05-26T23:13:06.0109582+02:00</StartDate>
</ClientplanSector>
</ArrayOfClientplanSector>