GET PlanCare2Api/Clients/{clientId}/LawStatus

Get the client's law status

Requires 'Read' permission for function ClientLawStatus {4F25CFAD-284C-4D4B-89A7-27989D2371CB}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

internal client identifier

 integer

Required

Body Parameters

None.

Response Information

Resource Description

The client's law statuses

Collection of ClientLawStatus
NameDescriptionTypeAdditional information
ClientId

Client id

 integer

None.
StartDate

Start date of the clients law status

 date

None.
EndDate

End date of the clients law status

 date

None.
LawStatus

Description of the law status

 string

None.
LawStatusId

Id of the law status

 integer

None.
FirstRelationCorrelationId

Id of the first correlation

 integer

None.
SecondRelationCorrelationId

Id of the second correlation

 integer

None.
ThirdRelationCorrelationId

Id of the third correlation

 integer

None.
FourthRelationCorrelationId

Id of the fourth correlation

 integer

None.
FirstRoleName

Name of the role of the first correlation

 string

None.
SecondRoleName

Name of the role of the second correlation

 string

None.
ThirdRoleName

Name of the role of the third correlation

 string

None.
FourthRoleName

Name of the role of the fourth correlation

 string

None.
FirstRelationCorrelationName

Name of the first correlation

 string

None.
SecondRelationCorrelationName

Name of the second correlation

 string

None.
ThirdRelationCorrelationName

Name of the third correlation

 string

None.
FourthRelationCorrelationName

Name of the fourth correlation

 string

None.
FirstRoleRelationId

Id of the role of the first correlation

 integer

None.
SecondRoleRelationId

Id of the role of the second correlation

 integer

None.
ThirdRoleRelationId

Id of the role of the third correlation

 integer

None.
FourthRoleRelationId

Id of the role of the fourth correlation

 integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "$id": "1",
    "ClientId": 1,
    "StartDate": "2026-05-26T22:10:35.7948827+02:00",
    "EndDate": "2026-05-26T22:10:35.7948827+02:00",
    "LawStatus": "sample string 3",
    "LawStatusId": 4,
    "FirstRelationCorrelationId": 1,
    "SecondRelationCorrelationId": 1,
    "ThirdRelationCorrelationId": 1,
    "FourthRelationCorrelationId": 1,
    "FirstRoleName": "sample string 5",
    "SecondRoleName": "sample string 6",
    "ThirdRoleName": "sample string 7",
    "FourthRoleName": "sample string 8",
    "FirstRelationCorrelationName": "sample string 9",
    "SecondRelationCorrelationName": "sample string 10",
    "ThirdRelationCorrelationName": "sample string 11",
    "FourthRelationCorrelationName": "sample string 12",
    "FirstRoleRelationId": 1,
    "SecondRoleRelationId": 1,
    "ThirdRoleRelationId": 1,
    "FourthRoleRelationId": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfClientLawStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
  <ClientLawStatus>
    <ClientId>1</ClientId>
    <EndDate>2026-05-26T22:10:35.7948827+02:00</EndDate>
    <FirstRelationCorrelationId>1</FirstRelationCorrelationId>
    <FirstRelationCorrelationName>sample string 9</FirstRelationCorrelationName>
    <FirstRoleName>sample string 5</FirstRoleName>
    <FirstRoleRelationId>1</FirstRoleRelationId>
    <FourthRelationCorrelationId>1</FourthRelationCorrelationId>
    <FourthRelationCorrelationName>sample string 12</FourthRelationCorrelationName>
    <FourthRoleName>sample string 8</FourthRoleName>
    <FourthRoleRelationId>1</FourthRoleRelationId>
    <LawStatus>sample string 3</LawStatus>
    <LawStatusId>4</LawStatusId>
    <SecondRelationCorrelationId>1</SecondRelationCorrelationId>
    <SecondRelationCorrelationName>sample string 10</SecondRelationCorrelationName>
    <SecondRoleName>sample string 6</SecondRoleName>
    <SecondRoleRelationId>1</SecondRoleRelationId>
    <StartDate>2026-05-26T22:10:35.7948827+02:00</StartDate>
    <ThirdRelationCorrelationId>1</ThirdRelationCorrelationId>
    <ThirdRelationCorrelationName>sample string 11</ThirdRelationCorrelationName>
    <ThirdRoleName>sample string 7</ThirdRoleName>
    <ThirdRoleRelationId>1</ThirdRoleRelationId>
  </ClientLawStatus>
  <ClientLawStatus>
    <ClientId>1</ClientId>
    <EndDate>2026-05-26T22:10:35.7948827+02:00</EndDate>
    <FirstRelationCorrelationId>1</FirstRelationCorrelationId>
    <FirstRelationCorrelationName>sample string 9</FirstRelationCorrelationName>
    <FirstRoleName>sample string 5</FirstRoleName>
    <FirstRoleRelationId>1</FirstRoleRelationId>
    <FourthRelationCorrelationId>1</FourthRelationCorrelationId>
    <FourthRelationCorrelationName>sample string 12</FourthRelationCorrelationName>
    <FourthRoleName>sample string 8</FourthRoleName>
    <FourthRoleRelationId>1</FourthRoleRelationId>
    <LawStatus>sample string 3</LawStatus>
    <LawStatusId>4</LawStatusId>
    <SecondRelationCorrelationId>1</SecondRelationCorrelationId>
    <SecondRelationCorrelationName>sample string 10</SecondRelationCorrelationName>
    <SecondRoleName>sample string 6</SecondRoleName>
    <SecondRoleRelationId>1</SecondRoleRelationId>
    <StartDate>2026-05-26T22:10:35.7948827+02:00</StartDate>
    <ThirdRelationCorrelationId>1</ThirdRelationCorrelationId>
    <ThirdRelationCorrelationName>sample string 11</ThirdRelationCorrelationName>
    <ThirdRoleName>sample string 7</ThirdRoleName>
    <ThirdRoleRelationId>1</ThirdRoleRelationId>
  </ClientLawStatus>
</ArrayOfClientLawStatus>