GET PlanCare2Api/ClientplansV2/{clientplanId}/approvals

Retrieve the approvals 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 Identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of ClientplanApproval

Collection of ClientplanApproval

Name	Description	Type	Additional information
Id	The identifier of the clientplan approval.	globally unique identifier	-
Date	The creation date.	date	-
ConceptDocumentId	The identifier of the concept approval document.	integer	Nullable
ConceptDocumentName	The filename of the concept approval document.	string	-
SignedDocumentId	The identifier of the signed approval document.	integer	Nullable
SignedDocumentName	The filename of the signed approval document.	string	-
ApprovalDate	The date of approval.	date	Nullable
IsApproved	Is the approval approved.	boolean	-
DurationId	The identifier of the duration of the approval.	integer	Nullable
Duration	The period the approval is valid.	string	-
DurationNumber	The durationnumber the approval is valid.	integer	Nullable
DurationUnit	The unit of the period the approval is valid.	string	-
ExpirationDate	The calculated date until which the approval is valid.	date	Nullable
Parts	The clientplan parts associated with the approval.	Collection of string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": "dc7ea2fe-5a3e-4de6-8d0e-70bdc706322c",
    "Date": "2026-05-26T22:08:00.3179384+02:00",
    "ConceptDocumentId": 1,
    "ConceptDocumentName": "sample string 3",
    "SignedDocumentId": 1,
    "SignedDocumentName": "sample string 4",
    "ApprovalDate": "2026-05-26T22:08:00.3179384+02:00",
    "IsApproved": true,
    "DurationId": 1,
    "Duration": "sample string 6",
    "DurationNumber": 1,
    "DurationUnit": "sample string 7",
    "ExpirationDate": "2026-05-26T22:08:00.3179384+02:00",
    "Parts": [
      "sample string 1",
      "sample string 2"
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientplanApproval xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanApproval>
    <ApprovalDate>2026-05-26T22:08:00.3179384+02:00</ApprovalDate>
    <ConceptDocumentId>1</ConceptDocumentId>
    <ConceptDocumentName>sample string 3</ConceptDocumentName>
    <Date>2026-05-26T22:08:00.3179384+02:00</Date>
    <Duration>sample string 6</Duration>
    <DurationId>1</DurationId>
    <DurationNumber>1</DurationNumber>
    <DurationUnit>sample string 7</DurationUnit>
    <ExpirationDate>2026-05-26T22:08:00.3179384+02:00</ExpirationDate>
    <Id>dc7ea2fe-5a3e-4de6-8d0e-70bdc706322c</Id>
    <IsApproved>true</IsApproved>
    <Parts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Parts>
    <SignedDocumentId>1</SignedDocumentId>
    <SignedDocumentName>sample string 4</SignedDocumentName>
  </ClientplanApproval>
  <ClientplanApproval>
    <ApprovalDate>2026-05-26T22:08:00.3179384+02:00</ApprovalDate>
    <ConceptDocumentId>1</ConceptDocumentId>
    <ConceptDocumentName>sample string 3</ConceptDocumentName>
    <Date>2026-05-26T22:08:00.3179384+02:00</Date>
    <Duration>sample string 6</Duration>
    <DurationId>1</DurationId>
    <DurationNumber>1</DurationNumber>
    <DurationUnit>sample string 7</DurationUnit>
    <ExpirationDate>2026-05-26T22:08:00.3179384+02:00</ExpirationDate>
    <Id>dc7ea2fe-5a3e-4de6-8d0e-70bdc706322c</Id>
    <IsApproved>true</IsApproved>
    <Parts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Parts>
    <SignedDocumentId>1</SignedDocumentId>
    <SignedDocumentName>sample string 4</SignedDocumentName>
  </ClientplanApproval>
</ArrayOfClientplanApproval>