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	-
CorrelationId	The correlation id of the candidate.	integer	-
CorrelationStartDate	The start date of the correlation of the requested role.	date	Nullable
LookupName	The lookup name of the candidate.	string	-
Source	The source of the candidate.	ClientplanResponsiblePersonCandidateSource	-
Roles	The roles of the candidate for the clienplan type.	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "RelationId": 1,
    "CorrelationId": 2,
    "CorrelationStartDate": "2026-05-26T21:11:23.7952387+02:00",
    "LookupName": "sample string 3",
    "Source": 0,
    "Roles": "sample string 4"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientplanResponsiblePersonCandidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanResponsiblePersonCandidate>
    <CorrelationId>2</CorrelationId>
    <CorrelationStartDate>2026-05-26T21:11:23.7952387+02:00</CorrelationStartDate>
    <LookupName>sample string 3</LookupName>
    <RelationId>1</RelationId>
    <Roles>sample string 4</Roles>
    <Source>WithinClientNetwork</Source>
  </ClientplanResponsiblePersonCandidate>
  <ClientplanResponsiblePersonCandidate>
    <CorrelationId>2</CorrelationId>
    <CorrelationStartDate>2026-05-26T21:11:23.7952387+02:00</CorrelationStartDate>
    <LookupName>sample string 3</LookupName>
    <RelationId>1</RelationId>
    <Roles>sample string 4</Roles>
    <Source>WithinClientNetwork</Source>
  </ClientplanResponsiblePersonCandidate>
</ArrayOfClientplanResponsiblePersonCandidate>