GET PlanCare2Api/Clients/{clientId}/SpecialLegalStatus
Get the client's special legal status
Requires 'Read' permission for function ClientLegalStatus {7CDF2B6B-14D2-4F2A-AF83-FF73D57064DB}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
internal client identifier |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The client's special legal statuses
Collection of ClientSpecialLegalStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Id |
integer |
- |
| ClientId |
Client id |
integer |
- |
| RegistrationDate |
RegistrationDate |
date |
- |
| StartDate |
StartDate |
date |
- |
| EndDate |
EndDate |
date |
Nullable |
| LegalStatus |
LegalStatus |
string |
- |
| LegalStatusId |
LegalStatusId |
integer |
- |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": 1,
"ClientId": 2,
"RegistrationDate": "2026-05-26T22:08:57.9097822+02:00",
"StartDate": "2026-05-26T22:08:57.9097822+02:00",
"EndDate": "2026-05-26T22:08:57.9097822+02:00",
"LegalStatus": "sample string 5",
"LegalStatusId": 6
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfClientSpecialLegalStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
<ClientSpecialLegalStatus>
<ClientId>2</ClientId>
<EndDate>2026-05-26T22:08:57.9097822+02:00</EndDate>
<Id>1</Id>
<LegalStatus>sample string 5</LegalStatus>
<LegalStatusId>6</LegalStatusId>
<RegistrationDate>2026-05-26T22:08:57.9097822+02:00</RegistrationDate>
<StartDate>2026-05-26T22:08:57.9097822+02:00</StartDate>
</ClientSpecialLegalStatus>
<ClientSpecialLegalStatus>
<ClientId>2</ClientId>
<EndDate>2026-05-26T22:08:57.9097822+02:00</EndDate>
<Id>1</Id>
<LegalStatus>sample string 5</LegalStatus>
<LegalStatusId>6</LegalStatusId>
<RegistrationDate>2026-05-26T22:08:57.9097822+02:00</RegistrationDate>
<StartDate>2026-05-26T22:08:57.9097822+02:00</StartDate>
</ClientSpecialLegalStatus>
</ArrayOfClientSpecialLegalStatus>