GET PlanCare2Api/ClientplansV2/{clientplanId}/ResponsibleEmployeeCandidates?roleId={roleId}&includeEmployeesWithoutRole={includeEmployeesWithoutRole}
Retrieve the employees possible as responsible person for a clientplan V2 filtered by role.
Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientplanId |
The clientplan Id. |
integer |
Required |
| roleId |
The Id of the role to filter by. |
globally unique identifier |
Required |
| includeEmployeesWithoutRole |
Include all employees not assigned to the role. |
boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of possible responsible persons and their role in the clientplan.
Collection of ClientplanResponsiblePersonCandidate| Name | Description | Type | Additional information |
|---|---|---|---|
| RelationId |
The relation id of the candidate. |
integer |
None |
| CorrelationId |
The correlation id of the candidate. |
integer |
None |
| CorrelationStartDate |
The start date of the correlation of the requested role. |
date |
None |
| LookupName |
The lookup name of the candidate. |
string |
None |
| Source |
The source of the candidate. |
ClientplanResponsiblePersonCandidateSource |
None |
| Roles |
The roles of the candidate for the clienplan type. |
string |
None |
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.