GET PlanCare2Api/ClientPermissions?employeeId={employeeId}&clientId={clientId}&referenceDate={referenceDate}
Gets whether the specified employee has permission to access the specified client. Only allowed if request is for logged on employee or user has 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| employeeId |
The employee to obtain the ClientPermissions |
integer |
Required |
| clientId |
The client to obtain the permission for |
integer |
Required |
| referenceDate |
The date to obtain client permission for |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
The ClientPermission with the employee has rights to this client
ClientPermissions| Name | Description | Type | Additional information |
|---|---|---|---|
| EmployeeId |
The internal id of the employee |
integer |
Required |
| LookupName |
The fullname of the employee |
string |
Required |
| AllowedClients |
The list of clients the employee has access to |
Collection of AllowedClient |
- |
Response Formats
application/json, text/json
Sample:
{
"EmployeeId": 1,
"LookupName": "sample string 2",
"AllowedClients": [
{
"$id": "2",
"ClientId": 1,
"LookupName": "sample string 2"
},
{
"$ref": "2"
}
]
}
application/xml, text/xml
Sample:
<ClientPermissions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<AllowedClients>
<AllowedClient>
<ClientId>1</ClientId>
<LookupName>sample string 2</LookupName>
</AllowedClient>
<AllowedClient>
<ClientId>1</ClientId>
<LookupName>sample string 2</LookupName>
</AllowedClient>
</AllowedClients>
<EmployeeId>1</EmployeeId>
<LookupName>sample string 2</LookupName>
</ClientPermissions>