GET PlanCare2Api/ClientplansV2/{clientplanId}/ApprovalAuthorizedSignatories?referenceDate={referenceDate}

Retrieve the approval authorized signatory relations of a clientplan V2.

Requires 'Approve' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

Name Description Type Additional information
clientplanId

The clientplan ID.

integer

Required

referenceDate

Reference date for actual authorized signatories.

date

Required

Body Parameters

None.

Response Information

Resource Description

A list of ClientplanApprovalAuthorizedSignatory

Collection of ClientplanApprovalAuthorizedSignatory
Name Description Type Additional information
Id

Identifier of the signatory person.

integer

-

Name

Name of the signatory person.

string

-

RoleId

RoleId of the signatory person.

globally unique identifier

-

RoleName

Role of the signatory person.

string

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "RoleId": "7f3696d3-2d3e-457f-9944-9d4331b9cc17",
    "RoleName": "sample string 4"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfClientplanApprovalAuthorizedSignatory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanApprovalAuthorizedSignatory>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <RoleId>7f3696d3-2d3e-457f-9944-9d4331b9cc17</RoleId>
    <RoleName>sample string 4</RoleName>
  </ClientplanApprovalAuthorizedSignatory>
  <ClientplanApprovalAuthorizedSignatory>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <RoleId>7f3696d3-2d3e-457f-9944-9d4331b9cc17</RoleId>
    <RoleName>sample string 4</RoleName>
  </ClientplanApprovalAuthorizedSignatory>
</ArrayOfClientplanApprovalAuthorizedSignatory>