GET PlanCare2Api/WorkplansV2/{workplanId}/ActionCandidateExecutives?disciplineId={disciplineId}&referenceDate={referenceDate}

Gets candidate executives for a workplan action.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

Request Information

URI Parameters

Name	Description	Type	Additional information
workplanId	The id of the workplan for which to get the executives.	integer	Required
disciplineId	The id of the discipline for which to get the executives.	integer	Required
referenceDate	The date for which to get the executives.	date	Required

Body Parameters

None.

Response Information

Resource Description

A collection of possible executives for a workplan action.

Collection of ActionCandidateExecutive

Name	Description	Type	Additional information
RelationId	The relation id of the candidate.	integer	None
LookupName	The lookup name of the candidate.	string	None
Source	The source of the candidate.	WorkplanActionCandidateExecutiveSource	None
Role	The roles of the candidate for the clienplan type.	string	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "RelationId": 1,
    "LookupName": "sample string 2",
    "Source": 1,
    "Role": "sample string 3"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfActionCandidateExecutive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ActionCandidateExecutive>
    <LookupName>sample string 2</LookupName>
    <RelationId>1</RelationId>
    <Role>sample string 3</Role>
    <Source>Client</Source>
  </ActionCandidateExecutive>
  <ActionCandidateExecutive>
    <LookupName>sample string 2</LookupName>
    <RelationId>1</RelationId>
    <Role>sample string 3</Role>
    <Source>Client</Source>
  </ActionCandidateExecutive>
</ArrayOfActionCandidateExecutive>