GET PlanCare2Api/ClientPermissions?referenceDate={referenceDate}
Gets all employees with allowed clients
Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| referenceDate |
The date to obtain employees with allowed clients for |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
The ClientPermissions for all employees and the allowed clients
Collection of 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:
[
{
"$id": "1",
"EmployeeId": 1,
"LookupName": "sample string 2",
"AllowedClients": [
{
"$id": "2",
"ClientId": 1,
"LookupName": "sample string 2"
},
{
"$ref": "2"
}
]
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfClientPermissions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<ClientPermissions>
<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>
<ClientPermissions>
<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>
</ArrayOfClientPermissions>